Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ososuna/to-do-rest-v2
Refactor for to do rest API
https://github.com/ososuna/to-do-rest-v2
java rest-api spring spring-security
Last synced: 3 days ago
JSON representation
Refactor for to do rest API
- Host: GitHub
- URL: https://github.com/ososuna/to-do-rest-v2
- Owner: ososuna
- Created: 2022-08-15T01:56:11.000Z (over 2 years ago)
- Default Branch: develop
- Last Pushed: 2022-12-02T21:22:25.000Z (about 2 years ago)
- Last Synced: 2024-04-23T20:28:06.532Z (9 months ago)
- Topics: java, rest-api, spring, spring-security
- Language: Java
- Homepage:
- Size: 163 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# To Do API
## Contributors
| [
Oswaldo Osuna](https://ososuna.dev)
🐈⬛ ☕️ 🤠 | [
Ivan Mendoza](https://github.com/ivansmb11)
🍺 🤓 💻 |
| :---: | :---: |
## Requirements
For building and running the application you need:
- [JDK 11.0](https://www.oracle.com/mx/java/technologies/javase/jdk11-archive-downloads.html)
- [Maven 3](https://maven.apache.org)
## Running the application locally
There are several ways to run a Spring Boot application on your local machine. One way is to execute the `main` method in the `com.todo.todoapi.TodoApiApplication` class from your IDE.
Alternatively you can use the [Spring Boot Maven plugin](https://docs.spring.io/spring-boot/docs/current/reference/html/build-tool-plugins-maven-plugin.html) like so:
```shell
mvn spring-boot:run
```
## Try it out with Docker
First, build the application:
```shell
mvn package
```
Then you need to build the Docker image:
```shell
docker build -t to-do-api-v2 .
```
Now you can run the image:
```shell
docker run --name to-do-api-v2 -p 3001:3001 to-do-api-v2
```
## Run jacoco to check coverage in unit testing
```shell
mvn clean org.jacoco:jacoco-maven-plugin:0.8.8:prepare-agent
```
## Class Diagram
