https://github.com/ososuna/spring-book-api

📚 Rest API for Spring Book
https://github.com/ososuna/spring-book-api

aws-ec2 aws-s3 docker java mysql smtp spring-boot

Last synced: 3 days ago
JSON representation

📚 Rest API for Spring Book

• Host: GitHub
• URL: https://github.com/ososuna/spring-book-api
• Owner: ososuna
• Created: 2022-09-26T16:03:22.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-11-28T09:21:01.000Z (about 2 years ago)
• Last Synced: 2024-04-23T20:28:03.721Z (9 months ago)
• Topics: aws-ec2, aws-s3, docker, java, mysql, smtp, spring-boot
• Language: Java
• Homepage:
• Size: 1.18 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](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 `dev.ososuna.springbook.SpringBookApplication` 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 spring-book-api .

```

  

Now you can run the image:

  

```shell

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

```

## Entity Relationship Diagram



## Class Diagram



## Architecture Diagram