https://github.com/chijioke-ibekwe/library-management-system
RESTful APIs for a library management application built on Spring Boot 3
https://github.com/chijioke-ibekwe/library-management-system
Last synced: 3 months ago
JSON representation
RESTful APIs for a library management application built on Spring Boot 3
- Host: GitHub
- URL: https://github.com/chijioke-ibekwe/library-management-system
- Owner: chijioke-ibekwe
- Created: 2024-05-12T01:21:13.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-14T15:12:35.000Z (11 months ago)
- Last Synced: 2025-01-10T17:31:11.364Z (5 months ago)
- Language: Java
- Size: 169 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Library Management System
RESTful APIs for a library management application built on Spring Boot 3
## Getting Started
### Prerequisites
To successfully run this project, you'll need the following installed on your machine:
- **JDK >= v17.** That is because this project was developed using Spring Boot 3, which requires Java 17
as a minimum version.
- **Docker**
- **OpenSSL**
## How to Run
To run this project:
1. Clone the repository using the following command:
```
git clone https://github.com/chijioke-ibekwe/library-management-system.git
```
2. A docker compose file is attached to this project to help you easily set up your development databases. To do this,
run the following command on your terminal or command line, from the root directory of the project
```
docker compose up -d
```
This command will spin-up the following containers running in a detached mode:
- A postgres RDBMS running on `localhost:5431`
- A pgAdmin UI running on `localhost:5050` for managing the database, and
- A redis database running on `localhost:6379`
3. Use the `pgAdmin` interface, running on `localhost:5050` to interact with the `library-manager` database already created.
4. To run tests, run the following command from the root directory of the project:
```
./mvnw test
```
5. Generate the asymmetric keys for encrypting and decrypting the JWT, by running the `generate_keys.sh` script
from the root directory of the project using:
```
./generate_keys.sh
```
Ensure that the generated keys directory is git ignored to prevent committing them to source control
6. To start the application, run the following command:
```
./mvnw clean compile exec:java
```
Liquibase will run the migration files within the `src/main/resources/db` directory, upon startup, to set up the
database schema. The application will be running on `http://localhost:8081`
7. The Swagger API documentation for this project will be running on `http://localhost:8081/swagger-ui/index.html`
8. All the endpoints are protected (using Spring Security) aside from the user sign up, user login, and swagger docs
endpoints. Hence, you should take the following initial steps:
- Register a user using the sign up API `http://localhost:8081/swagger-ui/index.html#/user-controller/registerUser`
- Login with your credentials using the login API `http://localhost:8081/swagger-ui/index.html#/authentication-controller/login`
- Copy the access token returned from the step above
- Add it as a bearer token in the Authorization header of all subsequent calls to other APIs