Getting Started

Prepare Development Environment

1. Install JDK 11 : (jdk 11.0.18+10)

2. Install Maven : Maven

   • Download Binary (zip for Win tar.gz for Mac)
   • Extract the file in your dev env
   • Add the bin path to your $PATH

3. Install Node.js : (LTS : v18.15.0)

   • Install the Angular CLI :

     • FOR WINDOWS ONLY

       • Start Powershell with Admin Rights
       • Run this :

       Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned

       • Enter 'O' and tap Enter key

     • Start Terminal and run this :

     npm install -g @angular/cli

4. Install Docker : Docker

5. Configure VS Code

   • Add extensions :
     • Sonar Lint
     • Docker
     • GitLens
     • Maven

Test Environment

To verify if everything is correctly setup you just have to run build.sh

To run the script, you can use :

• Git bash on Windows
• Standard terminal on Linux/Mac

If the script end without error, you should be ready to dev !

Build for debugging

Back

• Run directly the Back-end with the "RUN" button on VS Code

Front

• Start the front using :

ng serve

Build for Production

When you want to build for prod, just run the 'build.sh' script and it will start a docker container with tomcat and your front and back.

The container is located on localhost:8080

Tools Used

Back-end :

• AZUL Zulu 11.62.17 (jdk 11.0.18+10)
• SpringBoot 2.7.9
• Maven 3.9.0

Font :

• Node.js v18.15.0
• Angular

Reference Documentation

For further reference, please consider the following sections:

• Official Apache Maven documentation
• Spring Boot Maven Plugin Reference Guide
• Spring Web
• Angular Documentation
• Docker CLI References
• Dockerfile References
• .gitlab-ci.yml (CI) References

Guides

The following guides illustrate how to use some features concretely:

• Building a RESTful Web Service
• Serving Web Content with Spring MVC
• Building REST services with Spring