Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sakthivelmadhu/catalog-management-system
This is a Spring Boot application for managing a catalog of products.
https://github.com/sakthivelmadhu/catalog-management-system
jdk maven mysql
Last synced: 25 days ago
JSON representation
This is a Spring Boot application for managing a catalog of products.
- Host: GitHub
- URL: https://github.com/sakthivelmadhu/catalog-management-system
- Owner: SakthivelMadhu
- Created: 2024-04-25T05:14:44.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-05-01T06:47:13.000Z (6 months ago)
- Last Synced: 2024-09-30T13:04:44.448Z (about 1 month ago)
- Topics: jdk, maven, mysql
- Language: Java
- Homepage:
- Size: 211 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Catalog Management System
This is a Spring Boot application for managing a catalog of products.
## Setup Instructions
### Prerequisites
- JDK (Java Development Kit) installed on your system.
- Maven build tool installed on your system.
- MySQL database server installed and running. Ensure you have the database URL, username, and password.
### Configuration
1. Clone or download the project source code from the repository.
2. Open the `application.properties` file located in the `src/main/resources` directory.
3. Configure the database connection properties:
```properties
spring.datasource.url=jdbc:mysql://localhost:3306/catalog_management_system
spring.datasource.username=root
spring.datasource.password=Sakthivel1402!
```
## Project Structure :
```bash
catalog-management-system
├── src
│ ├── main
│ │ ├── java
│ │ │ └── com
│ │ │ └── example
│ │ │ └── catalog
│ │ │ ├── controller
│ │ │ │ └── ProductController.java
│ │ │ ├── entity
│ │ │ │ └── Product.java
│ │ │ ├── repository
│ │ │ │ └── ProductRepository.java
│ │ │ ├── service
│ │ │ │ ├── ProductService.java
│ │ │ │ └── ProductServiceImpl.java
│ │ │ └── CatalogManagementSystemApplication.java
│ │ └── resources
│ │ ├── application.properties
│ │ ├── data.sql
│ │ └── logback.xml
└── README.md
└── pom.xml
```
### Build and Run
1. Build the project using Maven:
```bash
mvn clean package
```
2. Run the Spring Boot application:
```bash
java -jar target/catalog-management-system.jar
```
## Features
1. `CRUD Operations`: Perform Create, Read, Update, and Delete operations on product data.
2. `Search and Filtering`: Filter products based on various criteria using query parameters.
3. `Data Validation`: Input validation using validation annotations ensures data integrity.
4. `Data Persistence`: Utilize Spring Data JPA repositories for interacting with the database.
5. `Logging and Auditing`: Implement logging with Logback for tracking application events. Add auditing features to track changes made to product data.
6. `RESTful API`: Expose RESTful API endpoints for seamless integration with other systems.
7. `Documentation`: Clear and concise documentation on how to run the application and access API endpoints.
8. `Error Handling`: Gracefully handle validation errors and other exceptions, returning appropriate HTTP status codes.
### Accessing API Endpoints
Once the application is running, you can access the following API endpoints:
* GET all products: http://localhost:8080/products
* GET product by ID: http://localhost:8080/products/{id}
* POST create product: http://localhost:8080/products
* PUT update product: http://localhost:8080/products/{id}
* DELETE delete product: http://localhost:8080/products/{id}
## API Request/Response Formats
### GET all products
1. Request: GET /products
2. Response:
* Status Code: 200 OK
* Body: Array of product objects.
### GET product by ID
1. Request: GET /products/{id}
2. Response:
* Status Code: 200 OK if found, 404 Not Found if not found
* Body: Single product object.
### POST create product
1. Request: POST /products
2. Body:
```bash
{
"name": "Product Name",
"brand": "Product Brand",
"description": "Product Description",
"price": 10.99,
"quantity": 100,
"category": "Product Category"
}
```
3. Response:
* Status Code: 201 Created
* Body: Created product object.
### PUT update product
1. Request: PUT /products/{id}
2. Body:
```bash
{
"name": "Updated Product Name",
"brand": "Updated Product Brand",
"description": "Updated Product Description",
"price": 15.99,
"quantity": 150,
"category": "Updated Product Category"
}
```
3. Response:
* Status Code: 200 OK
* Body: Updated product object.
### DELETE delete product
1. Request: DELETE /products/{id}
2. Response:
* Status Code: 204 No Content if successful, 404 Not Found if product not found