README.md

todo-list-spring-java

A project regarding the practice and study of API REST using Spring (not complet yet, miss tests)

Technologies

• Java
• Spring Boot
• MySQL
• JPA
• OpenSwagger
• H2

Features

• Save a Todo
• Get all Todos
• Get a specific Todo
• Uptade a specific Todo
• Delete a specific Todo
• Filter Todos
• Delete All Todo's - Not done yet

Requirements

1. Java - 1.8.x

2. Maven - 3.x.x

3. MySQL - 5.x.x

Steps to Setup

1. Clone the application

git clone https://github.com/Itor-Carlos/todo-list-spring-java.git

2. Create MySQL database

create database todo_database

3. You can choose the profile that will be used

• To choose the profile, acess src/main/resources/application.properties

• If you choose test profile, acess src/main/resources/application.properties and change the parameter spring.profiles.active to test

• If you chose dev profile, acess src/main/resources/application.properties and change the parameter spring.profiles.active to test. After the previous step, acess src/main/resources/application-dev.properties and change spring.datasource.username and spring.datasource.password as per your mysql installation

4. Build and run the app using maven

mvn spring-boot:run

• The application will be start running at http://localhost:8080

• You can acess the api-docs from this application. To do this, go to http://localhost:8080/todo-api/swagger-ui/index.html after start application

This API will be modified in the future

• Unit Tests and Integration Tests
• Docker
• I wll change the Repository Interfaces. Maybe i should do a more specific to do not duplicate code