https://github.com/vickttor/nlw_journey_planner_java
Spring Boot Monolith API to handle the logic of the Planner application. The Planner application is a web and mobile based application that allow users to create a trip plan with friends
https://github.com/vickttor/nlw_journey_planner_java
Last synced: 5 months ago
JSON representation
Spring Boot Monolith API to handle the logic of the Planner application. The Planner application is a web and mobile based application that allow users to create a trip plan with friends
- Host: GitHub
- URL: https://github.com/vickttor/nlw_journey_planner_java
- Owner: vickttor
- Created: 2024-07-10T14:42:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-11T20:30:58.000Z (over 1 year ago)
- Last Synced: 2025-06-03T12:07:53.446Z (7 months ago)
- Language: Java
- Size: 45.9 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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:
```bash
# 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](https://www.docker.com/products/docker-desktop/)** and run the following command:
```bash
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:
```bash
docker compose down
```
### Improvements
- [X] Add validation to datetime properties
- [X] Extract the core logic of the Trips controller and add into a Service Class.
- [X] Implement Exception handlers do avoid the return of `500` server errors
- [X] Implement Postgres as the main database by using docker and docker compose
- [X] Create a `compose.yaml` file to execute the API and create the database with only one command.
```bash
docker compose up -d
```
- [ ] implement sending emails to trip participants
### Author
Victor H. Silva🚀
---