Version française

HostoCars

Vehicle repair management and invoicing web application.

Table of contents

• General info
• Technologies
• Setup
• License
• Links

General info

This web application is intended to help with the management of vehicles repairs, from the diagnostic to the billing. Its usage is expected to be intuitive and user-friendly.

The only available language is French and the project is not intended to be adapted for other languages, given the user panel it is designed for.

This application is expected to run correctly on the 2 last major versions of Google Chrome and Mozilla Firefox web browsers. Any other web browser or version won't be supported. Also, it is intended to be used on a computer, so as of today, no compatibility is planned for mobile.

Technologies

Backend

• Java: >11 (openJDK-11)
• Spring: 2.2.4.RELEASE
• Maven: 4.0.0

Frontend

• NodeJS: 14.16.0
• ReactJS: 16.13.1
• npm: 7.8.0

Setup

1. To run this project locally, you'll first need to set up Java, maven, node and npm.

For more info, you can check out the following guides:

• The Oracle's website for Java
• The Apache's website for maven
• The NodeJS website for NodeJS
• The npm website for npm

2. Then use maven to build the project using the following command at the project root:

./mvn clean install

3. Finally, to launch the application use the following command at the project root:

java -jar ./target/HostoCars.jar fr.foacs.hostocars.Application

4. Now the application should be accessible at localhost:8080.

Backend development

To fasten the backend build, you can specify the -Dskip-frontend_build option to maven in order to skip the frontend build:

./mvn clean install -Dskip-frontend-build

Frontend development

To help with frontend development, the node server can be started in parallel with the following command:

./src/main/javascript/npm run start

Then the local frontend implementation will be automatically compiled and executed at localhost:3000.

Also, to build the frontend without building the backend, you can use npm as follows:

./src/main/javascript/npm run build

In order for the latest frontend changes to be packaged, the project needs to be built again with the maven mvn clean install command.

Mails

To enable the mail support, you have to add a mail.properties file in the ./src/main/resources folder (alongside the application.properties file), with a mail.bearer.token property.

As an example, you can have a look at the example.mail.properties file.

In order to get a token for your use, you have to register an account on the FOACS organisation website, then create a token on your profile with the "(API) Mail d'erreur" token type. Be careful, as the token will only be displayed right after the creation and won't be accessible afterwards.

License

This project is licensed under the terms of the CeCILL license.

You can check out the full license here.

Links