https://github.com/ruben-rdez/student-mgmt

Student Management Backend
https://github.com/ruben-rdez/student-mgmt

docker docker-compose git github java maven mysql rest-api spring-data-jpa springboot

Last synced: 3 months ago
JSON representation

Student Management Backend

• Host: GitHub
• URL: https://github.com/ruben-rdez/student-mgmt
• Owner: ruben-rdez
• Created: 2025-03-13T21:47:02.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-19T17:40:07.000Z (over 1 year ago)
• Last Synced: 2025-03-19T18:29:24.673Z (over 1 year ago)
• Topics: docker, docker-compose, git, github, java, maven, mysql, rest-api, spring-data-jpa, springboot
• Language: Java
• Homepage:
• Size: 48.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Student Management Backend

This is a Spring Boot application for managing students. It provides a REST API for CRUD operations on student entities.

## Table of Contents

- [Features](#features)

- [Requirements](#requirements)

- [Installation](#installation)

- [Usage](#usage)

- [API Endpoints](#api-endpoints)

- [Running Tests](#running-tests)

## Features

- Create, read, update, and delete students

- REST API

- MySQL database integration

- Docker support

## Requirements

- Java 21

- Spring Boot 3.4.3

- Spring Data JPA

- Actuator

- Swagger

- Validation

- Lombok

- Model Mapper

- Maven

- MySQL

- Git

- GitHub

- Docker

- Logging with SLF4J

- Resilience4j for fault tolerance

- Rate Limiting with resilience4j

- Exception handling

## Installation

1. Clone the repository:

    git clone https://github.com/ruben-rdez/student-mgmt.git

2. Configure the database in application.properties:

    spring.datasource.url=jdbc:mysql://localhost:3306/studentsdb

    spring.datasource.driverClassName=com.mysql.cj.jdbc.Driver

    spring.datasource.username=username

    spring.datasource.password=password

3. Build the project:

   mvn clean package

## Usage

1. Run the application:

   mvn spring-boot:run

2. The application will be available at http://localhost:8080/swagger-ui/index.html

## API Endpoints

- `GET /students` - Get all students

- `GET /students/{id}` - Get a student by id

- `GET /students/{email}` - Get a student by email

- `POST /students` - Add a student

- `PUT /students/{id}` - Update a student

- `PATCH /students/{id}/email` - Update a student's email by id

- `DELETE /students/{id}` - Delete a student

## Running Tests

To run the tests, use the following command:

mvn test