Dance School RESTful API

Java Spring Boot, JPA, Hibernete, SQL, Firebase Authentication, Mavern, Lombok

A coding challenge developed in 2 days as the java version of an existing ASP.NET Core Web API that I developed.
The ASP.NET Core Version and live demo are here.

The Java Spring Boot back end of a web application designed for a small business that runs a dance school.
It includes an admin web portal for the business owner to view a dashboard and conduct CRUD operations.
It also includes a student protal for students to book classes and subscribe to memberships.
The users roles include the dance school owner (admin) and students.

Table of Contents

1. Future Plans and Improvements
2. API Documentation (Swagger)
3. Feature Highlights
4. Maintainability
5. Security
6. Scalability
7. Tech Stack
8. Design Patterns
9. How to run the program locally

Future Plans and Improvements

Task	Purpose
Logging	Capture errors from database and business logic to better audit the server
Deployment	Set up CI/CD pipelines for production
Error Handling	Apply built-in and custom Exceptions to enhance program transperency
Design Patterns	Apply common design patterns to reduce code redundancy

Feature Highlights

• An interactive admin dashboard with visualisations for data analytics
• Display data such as class information, instructors and memberships
• Allow the admin user full access on CURD operations.
• Allow the student role to view public data such as courses, membrships
• Allow the student role to book dance classes and subscribe to memberships

API Documentation (Swagger)

Development Highlights

Maintainability

Technology	Description
Domain-Driven Design	Encapsulation via seperating SQL queries from business logics through the repository pattern
Swagger API Documentation	Documented the API and multiple error response codes
OOP and DI	Abstracted duplicated codes into middlewares
Lombok	Reduced redundant codes in object oriented programming

Security and Robustness

Technology	Description
Firebase Auth	Authentication and role-based authorization implemented with middlewares to filter unauthenticated requests
Error handlings and Validations	Customised error response codes for business logics and model validations for data integrity
SQL Stored Procedures	Prevent SQL injection

Scalability and Performance

Technology	Description
Spring Caching	The Java Spring Boot Caching is utilised to boost query performance
Pagination	Fasten the loading time even with a huge amount of data
Advanced SQL	Restrict necessary data fields returned from the server. Map "1-to-many" relationships. Minimise database oprations with batch queries.

Tech Stack:

Back End: Java Spring Boot, JPA, Hibernete, SQL, Firebase Authentication, Mavern, Lombok

Design Patterns:

• Spring MVC
• Repository
• Dependency Injection
• Autowired Singletons
• Progressive Web Application with Spring Boot Caching

How to run the program locally:

First, create a firebase project to acquire your firebase authentication API credentials from Firebase Console.
Then, set up your local SQL server to achieve connection strings.
Alternatively, you can set up Azure SQL via Azure Portal.

Coming soon.