A Spring Boot Beer Viewing and Rating App

A simple Spring Boot app which displays a list of beers, information about them and allows the user to rate them. Supports user registration, authentication, search and rate functionality.

Instructions

1. Clone the repository to your local machine. Ensure you have Java 17, Maven, MySQL & Redis installed.
2. To run locally:
   1. Update the database credentials in application.yml.
   2. Start MySQL
   3. Start Redis (If you're using Windows, for easiness, run Redis using docker like so: docker run --name redis-dev -p 6379:6379 -d redis)
   4. Run the app using maven with mvn spring-boot:run or using your preferred IDE.
3. Alternatively, use Docker:
   1. docker run -p 8080:8080 --name spring-app my-spring-app
   2. docker-compose up --build
4. While the app is running, you can:
   1. Access the app's endpoints via browser, cURL, or any API client of your choice.
      A list of available endpoints (as JSON) can be found here.
   2. Explore the interactive API documentation via Swagger for more info.
   3. Check the application's health status using the Actuator health check endpoint

API Definition

Public Endpoints (do not require log in)

1. View all beers
2. View a beer's details
3. Sign up
4. Log in

User Endpoints (require log in)

1. View all user's ratings
2. Add/Edit rating to beer
3. Delete rating of beer
4. View account info

Admin Endpoints (require log in & admin rights)

1. Beers:
   • Add a new beer
   • Edit an existing beer's info
   • Delete a beer
2. Users:
   • View all users
   • Delete a user
3. Countries:
   • Get all countries
   • Add a country
   • Delete a country

DB Schema

Technologies

• Used JWT for authentication
• Used Redis for country management (since they're only stored as a String, this was a simple and effective solution, more light-weight than adding another SQL table.)
• Used OpenAPI for documentation
• Used Bruno for testing
• Used JUnit & Mockito for testing

To Dos

• Introduce docker
• Send verification emails to users upon sign up / add verification logic
• Implement FE
• Implement recommendation system

Support

For comments, ideas, issues or general talks about this project, feel free to open an issue.