Vehicle-Maintenance is a Java application based on Spring Boot that allows users to create and manage events. The application uses Swagger OpenAPI for API documentation, Maven for dependency management, Postgres as a relational database, Lombok to reduce code verbosity, and Mapstruct for object mapping.
To use the application, you must have Java 1.8 or 11 and Maven installed on your system. Additionally, you need to create an empty Postgres database and set the login credentials in the application.properties file.
Before starting the application, execute the command mvn clean install. By configuring the plugin in the pom.xml file, this command will generate the interfaces for your APIs and the required models.
mvn clean installTo run the application, clone the repository and then run the following command:
mvn spring-boot:runThe application will be available at http://localhost:`${server.port}` (see in application.yml).
The API documentation is available at http://localhost:`${server.port}`/swagger-ui.html.
You can use the Swagger Codegen plugin for Maven to automatically generate models and API interfaces based on your Swagger/OpenAPI specification.
For API security, Vehicle-Maintenance uses Spring Security and JWT. To access the APIs, include the JWT token in the Authorization header of your requests. The token can be obtained by sending a POST request to /api/auth/signin with a JSON body containing the username or e-mail and password.
To contribute to the application, follow these steps:
- Fork the repository
- Create a new branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request