pfs-intra/DEVELOP.md

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 (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.
• 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.
• Follow the tutorial at vaadin.com/docs/latest/tutorial/overview.
• Create new projects at start.vaadin.com.
• Search UI components and their usage examples at vaadin.com/docs/latest/components.
• View use case applications that demonstrate Vaadin capabilities at vaadin.com/examples-and-demos.
• Build any UI without custom CSS by discovering Vaadin's set of CSS utility classes.
• Find a collection of solutions to common use cases at cookbook.vaadin.com.
• Find add-ons at vaadin.com/directory.
• Ask questions on Stack Overflow or join our Discord channel.
• Report issues, create pull requests in GitHub.

Using git

• Using command line: https://git-scm.com/doc
• Using IDE: https://www.jetbrains.com/help/idea/using-git-integration.html