Hamdam23/bookee

bookee - Spring Boot project written using Java 17. Would be useful if you want to learn both simple BREAD operations and complex skills such as: Spring Security, Unit and Integration Testing, Database migration, i18n.

bookee - Find books you'll love, and keep track of the ones you want to read.

By Hamdam23

Table of Contents

• Tech Stack
• Database-Relationships
• API docs
• Usage
• Running
• Contact

Tech stack

This REST API is developed using Java programming language and Spring Boot starter of Spring framework. The full tech stack:

• Spring Boot
• Spring Security for authentication and authorization
• JWT for tokens and share security information between two parties — a client and a server
• AWS S3 for storing images and other files
• JUnit 5 for unit and integration tests
• TestContainer for using Docker images in integration tests
• Localstack for mocking AWS services in integration tests
• Spring Data JPA for data access layers
• PostgreSQL for Database
• FlywayDB for Database migrations
• Lombok for reducing boilerplate code
• and etc.

Database-Relationships

API docs

Check out. You can review Postman Documenter on this url.

Usage

Attention! This project uses environment variables for some configuration properties. Define your environment variables in application.yml file. Otherwise default values will be used.

• AWS_ACCESS_KEY
• AWS_SECRET_KEY

Hint: Get AWS access and secret keys from your Amazon Web Services console

Running

There are several ways to run a Spring Boot application on your local machine. One way is to execute the main method in the bookee.src.main.java.BookeeApplication class from your IDE.

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

mvn spring-boot:run

Contact

     

Released under the Apache License 2.0. See the LICENSE file.