Welcome to the Advanced Bookstore Inventory System! This project focuses on developing a robust API for managing books, authors, categories, and orders using Spring Boot. The system adheres to modern software construction principles and practices, emphasizing clean code, modularity, SOLID principles, and comprehensive API documentation.
The bookstore inventory system is designed to provide an efficient and user-friendly API for managing various aspects of a bookstore's inventory. It allows users to perform CRUD operations on books, authors, and categories, as well as manage orders. The project is divided into multiple milestones, each focusing on different aspects of system development.
- Book Management: CRUD operations for managing books, including creation, retrieval, update, and deletion.
- Author Management: CRUD operations for managing authors, including creation, retrieval, update, and deletion.
- Category Management: CRUD operations for managing categories, including creation, retrieval, update, and deletion.
- Order Management: Features for managing orders, including order creation, retrieval, update, and cancellation.
- Authentication and Authorization: User authentication, authorization, and role-based access control (RBAC) using Spring Security and JWT authentication.
- Advanced Features: Additional features such as search functionality, pagination, filtering, error handling, validation enhancement, and API versioning.
The project structure follows a standard Spring Boot application layout, organized into packages based on functionality. Below is an overview of the project structure:
<project_structure>
Follow these steps to set up and run the project locally:
-
Clone the Repository: git clone https://github.com/AshabaJasper/Bookstore-Inventory-API.git
-
Project Setup:
- Ensure you have Java Development Kit (JDK) installed on your system.
- Configure your preferred Integrated Development Environment (IDE) for Java development.
- Set up a MySQL or PostgreSQL database and configure the connection settings in
application.properties
.
- Build and Run the Application:
- Build the project using Maven or Gradle.
- Run the Spring Boot application.
- API Documentation:
- Access the API documentation using Swagger UI at API Documentation with Swagger.
For detailed documentation on the project setup, architecture, design decisions, and deployment guide, refer to the Documentation directory.
The project includes comprehensive unit tests, integration tests, and test coverage analysis. For details on testing methodologies and test coverage, refer to the Testing directory.
Continuous Integration (CI) and Continuous Deployment (CD) pipelines are set up to automate the build, test, and deployment processes. For details on the CI/CD pipeline setup, refer to the CI/CD Pipeline directory.
For detailed references and resources used in the development of the project, refer to the References file.
For potential future enhancements and features planned for the project, refer to the Future Enhancements file.