CONTRIBUTING.md

Contributing

Tools

To set up the development environment, ensure you have the following tools installed:

• Vscode (optional)
• OpenJDK 21
• Node.js 21
• Gradle (optional)

For Visual Studio Code, consider installing the following extensions:

• Language Support for Java(TM) by Red Hat for Vscode
• IntelliCode for Vscode (optional)
• Angular Language Service for Vscode (optional)
• SQLTools (optional)
  • SQLTools PostgreSQL Driver
• REST Client (optional)

Installation

• Backend Setup:

  • Start the PostgreSQL database using Docker:

    docker compose -f compose.dev.yml up -d

  • Run the Spring Boot API:

    gradle bootRun

• Frontend Setup:

  • Open a new terminal in challenge-facevault/web
  • Install dependencies:

    npm install

  • Start the Angular development server:

    ng serve

Testing API

For testing the API, I utilized the Vscode REST Client extension. You can find all the API requests in ./api-client/requests folder.

Additionally, for your convenience, I've created a public Postman workspace where you can test the API if you prefer using Postman. You can access the Postman workspace here.

Committing

• Conventional Commits
  • Angular Commit Convention

Useful Scripts

Backend:

• gradle bootRun: Start API.
• docker compose -f compose.dev.yml up -d: Start DB container in the background.
• docker compose -f compose.dev.yml down: Stop DB container.

Front-end:

• ng serve: Serve frontend using Angular CLI.

Reference

For further reference, please consider the following sections:

Backend

• Official Gradle documentation
• Spring Boot
• Lambok
• PostgreSQL
• Docker Docs

Additional Links

These additional references should also help you:

• Useful Springboot Tutorials

Frontend

• Angular 17 Docs
• Angular Signals
• Angular Signal Forms
• Ant Design Docs