University Management System

Description

The University Management System is a Spring-Boot web-application designed to simplify university administration by offering a centralized platform for managing academic operations. It features a RESTful API that handles user roles, course organization, and student enrollments - all secured through JWT authentication and role-based permissions.

Key Features:

• User Management: Create, update, and manage user roles (STUDENT, TEACHER, ADMIN).

• Course Management: Add, modify, or remove courses (FOR ADMINS), and track course details.

• Enrollment System: Handle student enrollments in courses with full CRUD functionality. (FOR TEACHERS/ADMINS)

• Security: Implements Spring Security and JWT for authentication and authorization.

How to Run the Project

1. Clone the Repository:

   git clone https://github.com/Timirlon/university-management-system.git
   cd university-management-system

2. Build the Project:

   Ensure you have Maven installed. Then, build the project using:

   ./mvnw clean install

3. Run the Application:

   Start the Spring Boot application with:

   ./mvnw spring-boot:run

4. Access the Application:

   Once running, the application will be accessible at http://localhost:8080.

Project Structure Overview

src/main/
├──java/org/exampleuniversity-management-system/
    ├── config/             # Configuration files for Spring Security
    ├── controller/         # API Controllers
    ├── dto/                # Data Transfer Objects
    ├── exception/          # Exception files and Error Handling
    ├── model/              # JPA Entities
    ├── repository/         # Spring Data JPA Repositories
    ├── security/           # Security model and service
    ├── service/            # Business logic and services
    ├── util/               # Utilitary classes
    └──UniversityManagementSystemApplication.java  # Entrypoint
└── resources/
    └── application.properties  

Example API Endpoints

The application provides wide range of functionality by implementing the following endpoints:

• User Management:

  • GET /users - Retrieve a list of all users
  • GET /users/{id} - Retrieve details of a specific users by id
  • PATCH /users/{id} - Update user credentials (Request Body needed)
  • PATCH /users/role/{id}?role={role} - Update user role (e.g. STUDENT, TEACHER, ADMIN)
  • DELETE /students/{id} - Remove a student by id from system

• Course Management:

  • GET /courses - Retrieve a list of all courses
  • GET /users/{id} - Retrieve details of a specific course by id
  • POST /courses - Add a new course (Request Body needed)
  • PATCH /courses/{id} - Update course information (Request Body needed)
  • DELETE /courses/{id} - Remove a course

• Enrollment:

  • GET /enrollments - Retrieve all enrollments
  • GET /enrollments/{id} - Retrieve details of a specific enrollment by id
  • POST /enrollments?student={studentId}&course={courseId} - Enroll a student in a course
  • PATCH /enrollments/{id}?student={studentId}&course={courseId} - Update enrollment information
  • DELETE /enrollments/{id} - Remove an enrollment

• Authentication

  • POST /auth/register - Registers and creates a new account
  • POST /auth/login - Logins into account and returns JWT

Used Technologies

• Java 21 - Main programming language
• Spring Boot 3 - Web-development framework
• Spring Security - Authentication and Authorization
• Spring Data JPA - Database interaction management
• PostgreSQL - Relational DBMS
• MapStruct - To Simplify Dto mapping
• Lombok - Provided helpful annotations
• JWT (Json Web Token) - Authentication Token

Build and Run Commands

• Build the Project:

  ./mvnw clean install

• Run the Application:

  ./mvnw spring-boot:run

Contact Information

For questions, suggestions, or contributions, please contact:

Temirlan Turgimbayev
Email: [[email protected]]
GitHub: Timirlon