ososuna / spring-book-api

📚 Rest API for Spring Book

Spring Book

Rest API for Spring Book

What is this?

Spring Book is a hybrid mobile application (iOS and Android) that allows the user to keep a record of their read books and access the functions available to apply a series of techniques that facilitate the understanding, memorization, and application of concepts learned at reading.

Requirements

For building and running the application you need:

• JDK 11.0
• Maven 3

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 dev.ososuna.springbook.SpringBookApplication class from your IDE.

Alternatively you can use the Spring Boot Maven plugin like so:

mvn spring-boot:run

Try it out with Docker

First, build the application:

mvn package

Then you need to build the Docker image:

docker build -t spring-book-api .

Now you can run the image:

docker run --name spring-book-api -p 3001:3001 spring-book-api

Entity Relationship Diagram

Class Diagram

Architecture Diagram