Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blandoncj/library-management-api
Library Management System API is a RESTful API developed with Java Spring Boot and MySQL for managing library operations. It allows admin management of books and loans, while customers can register and request loans. The API uses JWT for secure authentication.
https://github.com/blandoncj/library-management-api
api backend java jpa jwt maven mysql rest-api spring-boot spring-security-jwt
Last synced: 21 days ago
JSON representation
Library Management System API is a RESTful API developed with Java Spring Boot and MySQL for managing library operations. It allows admin management of books and loans, while customers can register and request loans. The API uses JWT for secure authentication.
- Host: GitHub
- URL: https://github.com/blandoncj/library-management-api
- Owner: blandoncj
- License: mit
- Created: 2024-10-15T19:54:53.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-22T13:47:08.000Z (3 months ago)
- Last Synced: 2024-11-02T01:07:30.602Z (2 months ago)
- Topics: api, backend, java, jpa, jwt, maven, mysql, rest-api, spring-boot, spring-security-jwt
- Language: Java
- Homepage:
- Size: 390 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Library Management System API
A **Library Management System API** built using **Java Spring Boot** and **MySQL**. This system allows both **administrators** and **customers** to manage a library's catalog, users, and book loans efficiently.
## Features ✨
### Administrator Features (1️⃣)
- **Manage Books**: List, search, register, edit, and deactivate books.
- **Manage Genres**: List, search, register, edit, and deactivate genres.
- **Manage Loans**: List and search loans, control book availability based on stock.
### Customer Features (2️⃣)
- **User Registration**: Customers can create their accounts.
- **Search Books**: Customers can browse and search for books available in the library.
- **Request Loans**: Customers can request loans for available books.
- **Update Account**: Edit account information.
- **Delete Account**: Permanently remove their account.
---
### Security Features 🔐
- **Role and Permission Management**: The system uses `Role` and `Permission` entities to handle user roles (e.g., **admin**, **customer**) and permissions for controlling the resources.
- **JWT Authentication**: Implemented **JSON Web Token (JWT)** authentication for secure login, ensuring that only authenticated users with with the appropriate roles can access certain endpoints.
- **Spring Security**: The system integrates **Spring Security** to protect the API, managing role-based access control to different resources and operations.
---
## Technologies Used 🚀
- **Java** with **Spring Boot** for backend API development.
- **MySQL** for database management.
- **Maven** for dependency management.
- **JPA (Java Persistence API)** for database interaction.
- **JWT** for secure authentication.
- **Spring Security** for role-based authorization.
- **RESTful Services** for communication between frontend and backend.
---
## Getting Started 🛠️
### Prerequisites
Make sure you have the following installed:
- [JDK 17](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)
- [Maven](https://maven.apache.org/install.html)
- [MySQL](https://www.mysql.com/downloads/)
### Installation
1. Clone the repository:
```bash
git clone https://github.com/blandoncj/library-management-api.git
```
2. Navigate to the project directory:
```bash
cd library-management-api
```
3. Set up the MySQL database:
- Create a MySQL database named `library_db` or as specified in `application.properties`.
- Update the MySQL connection credentials in `src/main/resources/application.properties`:
```properties
spring.datasource.url=jdbc:mysql://localhost:3306/library_db
spring.datasource.username=your-username
spring.datasource.password=your-password
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.jpa.hibernate.ddl-auto=create
spring.jpa.properties.hibernate.format_sql=true
spring.jpa.show-sql=true
security.jwt.key.private=your-secret-key
security.jwt.user.generator=your-user-generator
```
4. Install dependencies and build the project using Maven:
```bash
mvn clean install
```
5. Run the application:
```bash
mvn spring-boot:run
```
---
## Database Schema 🗂️
The system uses a **relational database (MySQL)** with the following main entities:
- **Book**: Represents a book in the library.
- **Genre**: Represents the genre of a book.
- **User**: Represents a user of the library.
- **Loan**: Represents a book loan requested by a customer.
- **Role**: Represents the role of a user (e.g., Admin, Customer).
- **Permission**: Represents specific permissions that can be assigned to roles.
---
## Future Improvements 🚧
Here are some future enhancements planned for the system:
- Implement **unit tests** and **integration tests** for the API.
- Improve the **pagination** in listing endpoints.
- Deploy the API on a cloud service (e.g., Heroku or AWS).
---
## Contribution Guidelines 🤝
Contributions are welcome! If you'd like to help improve this project, please follow these steps:
1. Fork the repository.
2. Create a new branch (`git chekout -b feature/new-feature`).
3. Commit your changes (`git commit -m 'Add a new feature'`).
4. Push to the branch (`git push origin feature/new-feature`).
5. Open a pull request.
---
## License 📝
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
---
## Contact 📧
For any questions or feedback, feel free to reach out at:
- **Email**: [email protected]
- **GitHub**: [blandoncj](https://github.com/blandoncj)
---
**Enjoy managing your library! 📚**