https://github.com/pratikjasl/badminton-academy

Badminton Academy Application
https://github.com/pratikjasl/badminton-academy

dbms development express-js jwt-authentication postgresql prisma-orm reactjs state-management

Last synced: about 1 year ago
JSON representation

Badminton Academy Application

• Host: GitHub
• URL: https://github.com/pratikjasl/badminton-academy
• Owner: PratikJasl
• Created: 2025-03-08T04:14:30.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-04-11T10:54:45.000Z (about 1 year ago)
• Last Synced: 2025-04-12T06:53:41.159Z (about 1 year ago)
• Topics: dbms, development, express-js, jwt-authentication, postgresql, prisma-orm, reactjs, state-management
• Language: TypeScript
• Homepage:
• Size: 36.8 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Badminton Academy Web Application

## Functional Requirements

1) **Role-Based Access Control (RBAC):** Define roles with specific permissions: students, coaches, and admins.

2) **User Management:** Store and manage detailed user profiles (name, contact, role, etc.).

3) **Attendance Tracking:** Track student attendance for each session.

4) **Payment Tracking:** Monitor student payments, with automated updates on payment due dates and status.

5) **Coach Management:** Allow admins to add and manage coach details (name, experience, availability).

6) **Location Management:** Enable coaches to add and manage training locations.

7) **Coaching Plans:** Allow coaches to create and modify coaching plans.

8) **Coaching Schedule Management:** Enable coaches to add, update, and manage training schedules.

9) **Attendance Marking by Coaches:** Allow coaches to mark student attendance for each session.

10) **Payment Tracking by Coaches:** Allow coaches to track and update payment statuses for students.

## Non-Functional Requirements

1) **Data persistence:** Persist the user payment and attendance data.

2) **Security:** Ensure user data is protected.

3) **Reliability:** Ensure high availability and failover mechanisms to keep the system running smoothly even during maintenance or unexpected issues.

## System Constraints

1) **MVP (Minimum Viable Product):** Focus on creating the most important features first.

2) **Limited resources:** Only 2 developers available.

## SEQUENCE DIAGRAM

•	The sequence diagram entails the below mentioned details:

1)	It describes all the different entities involved in the system.

2)	It describes all the API endpoints our system will contain.

3)	It describes the different HTTP methods to be used along with the endpoints.

4)	It describes all the use cases for which our system will be used for.

5)	It describes all the different data formats being shared between the different entities.

6)	It describes the data flow between the different entities of the system.

![Sequence Diagram](./client/src/assets/Badminton%20Academy%20Sequence%20Diagram.png)

## TECHINAL STACK

1) **Client Side [Front-end]**

    Technology Used: React.js, Tailwind CSS

    Language: Typescript 

    Version: 18.x

    Libraries: Recoil [version: 0.7.x], React-charts, React-table, React hook forms

2) **Business Logic [Back-end]**

    Technology Used: Node.js  

    Language: Typescript

    Version: 20.18.0 LTS [NES can be added]

    Framework: Express [version: 4.x]

3) **Database**

    Technology Used: Postgres SQL 2022

    Version: 2022

4) **Authentication and Authorization**

    Technology Used: JWT Tokens along with Email OTP verification

    Package: jsonwebtoken, node-mailer

5)	**API Standard**

    Technology Used: REST API’s

6)	**Error Logging**

    Error Logging system will be used in the backend.

    Libraries like “Winston” can be used for Error Logging.

## SYSTEM DESIGN

![System Design](./client/src/assets/Badminton_Academy_System_Design.png)

## DATABASE SCHEMA

![DataBase Schema](./client/src/assets/Badminton_Acadmey_DB_DESIGN.png)

## Suggestions

1) Security: JWT authentication checking on protected routes.

2) Decoupling: Create a service layer to de-couple controllers. 

3) TabNapping: In frontend avoid tab napping errors in href tags to external links.

4) Load Carausel Image: Load the first carousel image early to avoid delay.

5) In UI check re-rendering due to various states.

6) Remove delete button from locations where there are users associated or give appropriate message.

7) Check case where JWT is expired, prompt the user to login again. 

8) Check cross tab sync as well.