L'API dont vous êtes le héros is an interactive Java API that brings the adventure of "choose your own adventure" stories to life. Users can embark on unique journeys, make decisions at each step, and create dynamic narratives, all while experiencing the nostalgia of classic adventure books.
We need to include a step-by-step guide in the documentation that explains how to clone, configure, and run the project. This will help new contributors quickly get the project running in their local environment.
Task:
[x] Document the prerequisites (JDK, Maven, Docker, etc.).
[x] Provide steps for cloning the repository and setting up environment variables.
[x] Include instructions to start MongoDB (use Docker).
[x] Detail how to install dependencies and run the project using Maven or an IDE.
[x] Add a section for testing the API using Postman (JWT tokens, authentication).
Quest:
We need to include a step-by-step guide in the documentation that explains how to clone, configure, and run the project. This will help new contributors quickly get the project running in their local environment.
Task:
[x] Document the prerequisites (JDK, Maven, Docker, etc.).
[x] Provide steps for cloning the repository and setting up environment variables.
[x] Include instructions to start MongoDB (use Docker).
[x] Detail how to install dependencies and run the project using Maven or an IDE.
[x] Add a section for testing the API using Postman (JWT tokens, authentication).
The keeper of the repo 🏰