From eafd72c1424b7dd90a3c920d3cbe3a591a755979 Mon Sep 17 00:00:00 2001 From: Alex Prudencio Date: Thu, 15 Aug 2024 08:24:39 -0400 Subject: [PATCH] add doc --- DEVELOP.md | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 47 ++++---------------------------------- 2 files changed, 71 insertions(+), 43 deletions(-) create mode 100644 DEVELOP.md diff --git a/DEVELOP.md b/DEVELOP.md new file mode 100644 index 0000000..ad19b6f --- /dev/null +++ b/DEVELOP.md @@ -0,0 +1,67 @@ +# Develop + +## Requirements + +1. Install Intellij Idea Community edition: https://www.jetbrains.com/idea/download +2. Checkout source code: https://git.primefactorsolutions.com/PFS/pfs-intra + - credentials are the same as ldap user (email username without domain name/password) +3. Open project in IntelliJ + - requires JDK 21 +4. Optional: + - git + +## Running the application + +The project is a standard Maven project. To run it from the command line, +type `mvnw` (Windows), or `./mvnw` (Mac & Linux), then open +http://localhost:8080 in your browser. + +You can also import the project to your IDE of choice as you would with any +Maven project. Read more on [how to import Vaadin projects to different IDEs](https://vaadin.com/docs/latest/guide/step-by-step/importing) (Eclipse, IntelliJ IDEA, NetBeans, and VS Code). + +## Deploying to Production + +To create a production build, call `mvnw clean package -Pproduction` (Windows), +or `./mvnw clean package -Pproduction` (Mac & Linux). +This will build a JAR file with all the dependencies and front-end resources, +ready to be deployed. The file can be found in the `target` folder after the build completes. + +Once the JAR file is built, you can run it using +`java -jar target/pfs-intra-1.0-SNAPSHOT.jar` + +## Project structure + +- `MainLayout.java` in `src/main/java` contains the navigation setup (i.e., the + side/top bar and the main menu). This setup uses + [App Layout](https://vaadin.com/docs/components/app-layout). +- `views` package in `src/main/java` contains the server-side Java views of your application. +- `views` folder in `src/main/frontend` contains the client-side JavaScript views of your application. +- `themes` folder in `src/main/frontend` contains the custom CSS styles. + +## Useful links + +### Spring boot + +- https://docs.spring.io/spring-boot/index.html + +### JPA/Hibernate + +- https://docs.spring.io/spring-data/jpa/reference/index.html + +### Vaadin + +- Read the documentation at [vaadin.com/docs](https://vaadin.com/docs). +- Follow the tutorial at [vaadin.com/docs/latest/tutorial/overview](https://vaadin.com/docs/latest/tutorial/overview). +- Create new projects at [start.vaadin.com](https://start.vaadin.com/). +- Search UI components and their usage examples at [vaadin.com/docs/latest/components](https://vaadin.com/docs/latest/components). +- View use case applications that demonstrate Vaadin capabilities at [vaadin.com/examples-and-demos](https://vaadin.com/examples-and-demos). +- Build any UI without custom CSS by discovering Vaadin's set of [CSS utility classes](https://vaadin.com/docs/styling/lumo/utility-classes). +- Find a collection of solutions to common use cases at [cookbook.vaadin.com](https://cookbook.vaadin.com/). +- Find add-ons at [vaadin.com/directory](https://vaadin.com/directory). +- Ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/vaadin) or join our [Discord channel](https://discord.gg/MYFq5RTbBn). +- Report issues, create pull requests in [GitHub](https://github.com/vaadin). + +### Using git + +- Using command line: https://git-scm.com/doc +- Using IDE: https://www.jetbrains.com/help/idea/using-git-integration.html \ No newline at end of file diff --git a/README.md b/README.md index 5dd93e3..f0a605a 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,6 @@ # pfs-intra -This project can be used as a starting point to create your own Vaadin application with Spring Boot. -It contains all the necessary configuration and some placeholder files to get you started. - -## Running the application - -The project is a standard Maven project. To run it from the command line, -type `mvnw` (Windows), or `./mvnw` (Mac & Linux), then open -http://localhost:8080 in your browser. - -You can also import the project to your IDE of choice as you would with any -Maven project. Read more on [how to import Vaadin projects to different IDEs](https://vaadin.com/docs/latest/guide/step-by-step/importing) (Eclipse, IntelliJ IDEA, NetBeans, and VS Code). - -## Deploying to Production - -To create a production build, call `mvnw clean package -Pproduction` (Windows), -or `./mvnw clean package -Pproduction` (Mac & Linux). -This will build a JAR file with all the dependencies and front-end resources, -ready to be deployed. The file can be found in the `target` folder after the build completes. - -Once the JAR file is built, you can run it using -`java -jar target/pfs-intra-1.0-SNAPSHOT.jar` - -## Project structure - -- `MainLayout.java` in `src/main/java` contains the navigation setup (i.e., the - side/top bar and the main menu). This setup uses - [App Layout](https://vaadin.com/docs/components/app-layout). -- `views` package in `src/main/java` contains the server-side Java views of your application. -- `views` folder in `src/main/frontend` contains the client-side JavaScript views of your application. -- `themes` folder in `src/main/frontend` contains the custom CSS styles. - -## Useful links - -- Read the documentation at [vaadin.com/docs](https://vaadin.com/docs). -- Follow the tutorial at [vaadin.com/docs/latest/tutorial/overview](https://vaadin.com/docs/latest/tutorial/overview). -- Create new projects at [start.vaadin.com](https://start.vaadin.com/). -- Search UI components and their usage examples at [vaadin.com/docs/latest/components](https://vaadin.com/docs/latest/components). -- View use case applications that demonstrate Vaadin capabilities at [vaadin.com/examples-and-demos](https://vaadin.com/examples-and-demos). -- Build any UI without custom CSS by discovering Vaadin's set of [CSS utility classes](https://vaadin.com/docs/styling/lumo/utility-classes). -- Find a collection of solutions to common use cases at [cookbook.vaadin.com](https://cookbook.vaadin.com/). -- Find add-ons at [vaadin.com/directory](https://vaadin.com/directory). -- Ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/vaadin) or join our [Discord channel](https://discord.gg/MYFq5RTbBn). -- Report issues, create pull requests in [GitHub](https://github.com/vaadin). +`pfs-intra` is the company's management systems: + - HR; + - Recruiting; + - Employees.