https://github.com/astarell/scheduleserver
A pet-project representing a student REST API schedule server
https://github.com/astarell/scheduleserver
hibernate-orm java rest-api spring-boot spring-data-jpa swagger
Last synced: 2 months ago
JSON representation
A pet-project representing a student REST API schedule server
- Host: GitHub
- URL: https://github.com/astarell/scheduleserver
- Owner: Astarell
- Created: 2024-06-30T15:33:26.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-01T10:07:41.000Z (about 2 years ago)
- Last Synced: 2025-02-24T06:44:35.720Z (over 1 year ago)
- Topics: hibernate-orm, java, rest-api, spring-boot, spring-data-jpa, swagger
- Language: Java
- Homepage:
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ScheduleServer
This is a part of a simlpe pet-project that demonstrates basic skills in working with REST API in compartment with the Spring ecosystem.
It is a REST API for managing a small educational institution. The User has the opportunity to form study groups, make a schedule, appoint people responsible for conducting classes. All CRUD-operations are available.
The project also used Swagger for documenting endpoints and providing a platform for manual testing.
Technologies:
- Spring Framework: Spring Boot, Spring Core, Spring Data JPA
- Maven
- Hibernate ORM
- PostgreSQL
- Swagger
## How to run locally
Create the 'application.properties' file and set the following configuration.
Common settings:
- server.port
For the Spring Data JPA set :
- spring.datasource.driver-class-name
- spring.datasource.url
- spring.datasource.username
- spring.datasource.password
- spring.jpa.hibernate.ddl-auto=update (or any other needed option)
## Short overview
### Swagger
To examine the documentation generated by Swagger, you need to enter the following link: {server_url}/swagger-ui/index.html#/
### The database relationships schema
