Developper

How to Contribute as a Developer to the Project

The application is divided into four main parts:

Backend

The backend is built using Quarkus and is located in the /backend directory.

Webapp

The web application is developed using Tauri, Vite, and Vue, and can be found in the /webapp directory.

Website

The website is created with Vite and Vue and is located in the /website directory.

Deployment

The deployment setup includes Keycloak and PostgreSQL, found in the /deployment directory.

How to Run the Project in Dev Mode

To get the project up and running in development mode, follow these steps:

1. Start the deployment services:

   cd /deployment/dev && docker compose up -d

2. Start the backend server:

   cd /backend && mvn quarkus:dev

3. Start the web application:

   cd /webapp && npm run tauri-dev

4. Start the website:

   cd /website && npm run dev

How to Contribute via a Pull Request

To contribute to the project, please follow these steps:

1. Fork the Repository

   • Create a fork of the repository on GitHub.

2. Clone Your Fork

   • Clone your fork to your local machine:

     git clone https://github.com/your-username/your-fork.git

3. Create a Branch

   • Create a new branch for your feature or bug fix:

     git checkout -b your-feature-branch

4. Make Your Changes

   • Implement your changes with clear and concise commits.

5. Write Descriptive Commit Messages

   • Write meaningful commit messages that describe the changes you made.

6. Push to Your Fork

   • Push your branch to your forked repository:

     git push origin your-feature-branch

7. Open a Pull Request

   • Navigate to the original repository and open a pull request from your fork.

8. Ensure All Tests Pass

   • Make sure all tests in the pipeline pass before submitting your pull request. Your pull request will not be accepted if the tests do not pass.

9. Review and Feedback

   • Be responsive to feedback and make necessary changes.

Following these steps ensures that your contributions are well-integrated into the project.