CollegeStudentApp

This project is a REST API for the Masai College Student Application. The API allows students to view their schedules, grades, and attendance, as well as register and log in to the application.

Tech Stack

• Java
• Spring Framework
• Spring Boot
• Spring Data JPA
• MySQL
• Swagger UI
• Lambok
• Maven

Modules

• User Module
• Schedule Module
• Grade Module
• Attendance Module

Validation

• This project uses validation annotations to ensure that user input is in the correct format. The following validations are implemented:

• First Name: Must not contain numbers or special characters

• Last Name: Must not contain numbers or special characters

• Email: Must be in a valid email format

• Password: Must be alphanumeric and contain 6-12 characters with at least one special character, one upper case, one lowercase, and one digit

Exception Handling

• Custom exceptions are used for handling errors in the application.
• A global exception handler is used to handle exceptions globally.

Authentication

• Basic authentication is implemented for user registration and login.

Installation & Run

• Before running the API server, you should update the database config inside the application.properties file.
• Update the port number, username and password as per your local database configuration.

spring.datasource.url=jdbc:mysql://localhost:3306/StudentDB;
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.username=root
spring.datasource.password=root

API Root Endpoint

https://localhost:8080/

http://localhost:8080/swagger-ui/