Planner 📅

RestFull monolith API using Spring Boot. This API handles the logic of a web and mobile based application called Planner. The Planner application is used to create travel plans. It stores trips information such as important links, activities to be realized and participants.

This project was built during the Rocketseat NLW Journey, a 3-day event to learn a new stack.

Status 🏗️

• Base version finished!
  • Under improvement 🚀

Tech Stack

• Java 17
• Maven
• Spring Boot
• Lombok
• Fly Way
• Postgres SQL
• Hibernate JPA
• Spring Boot DevTools
• Docker

How to run

Install the git CLI into your machine and clone this repository by using HTTPS or SSH:

# HTTPS
git clone https://github.com/vickttor/nlw_journey_planner_java.git

# SSH
git clone git@github.com:vickttor/nlw_journey_planner_java.git 

Install the Docker and run the following command:

docker compose up -d

This command will execute the steps of the compose.yaml file execute both API and PostgreSQL database. To stop the execution, run:

docker compose down

Improvements

• Add validation to datetime properties
• Extract the core logic of the Trips controller and add into a Service Class.
• Implement Exception handlers do avoid the return of 500 server errors
• Implement Postgres as the main database by using docker and docker compose
• Create a compose.yaml file to execute the API and create the database with only one command.

  docker compose up -d

• implement sending emails to trip participants

Author

_{Victor H. Silva}🚀

---