Student Server

| English | Turkish |

Explore the more documentation »

Project Overview

This project encompasses a web-based information management application for storing, managing, and presenting student records. It includes a database management system for student information such as names, surnames, ID numbers, birthdates, registration dates, and course times. Additionally, it automatically tracks the time of each student's registration in the system.

The project is developed using Java technologies like Spring Boot and Hibernate. Lombok library is utilized to reduce code repetitions and create a more readable structure. JpaRepository is used for database operations.

The project features API endpoints for listing student data, searching by student OID, adding new students, updating existing student information, and deleting student records. After each operation, relevant logs are generated to record the status of the operation, making it traceable when needed.

The goal of this project is to develop a modern and user-friendly web application that effectively manages student information.

Getting Started

Install Java 17

• This application requires Java 17.
• Please click the link below to download and install Java-17: Java-17

Install Gradle 8.7

• This application requires Gradle-8.7.
• Please click the link below to download and install Gradle-8.7: Gradle-8.7

Install & Setup Database

• This application requires MySQL 8.
• Please click the link below to download and install MySQL-8: MySQL-8
• You can use the following file to create a database: db_setup.sql

Install Student-Cronjob Project

• If you want to update students' remaining course duration on a daily basis, you can download the Student-Cronjob project from: Student-Cronjob

Running the application

• Clone the repo

  git clone https://github.com/harunsefainan/student-server

• Open the project in IntelliJ IDEA or any suitable IDE of your choice.
• Run the project.
• Open the browser and locate to localhost:8080 (If you changed the port use changed port instead of 8080)

Project Details

Database

Swagger Documentatiton

You can access the API documentation at http://localhost:8080/swagger-ui/index.html. If you can't see the endpoints when you access the Swagger page, make sure that you typed /v3/api-docs in the search bar and click explore button.

We have an encryption mechanism on the API. If you want to access the endpoints, use the username and password given below;

• Username - Password
  • User - User

To view all students, follow the instructions below;

• Go to endpoint v1/api/students/getAll .

Follow the instructions below to view students by oid;

• Go to endpoint v1/api/students/getByOID/{oid} and fill in the required fields.

Follow the instructions below to create a new student;

• Go to endpoint v1/api/students/newStudent and fill in the required fields.

Follow the instructions below to update student information;

• Go to endpoint v1/api/students/updateStudent and fill in the required fields.

Follow the instructions below to delete student information;

• Go to endpoint v1/api/students/deleteStudent/{oid} and fill in the required fields.

Built With

---

---

(back to top)