https://github.com/nethmiumaya/spring-pos-backend
A comprehensive Spring backend API designed for seamless point-of-sale management.
https://github.com/nethmiumaya/spring-pos-backend
logback restful-api spring
Last synced: about 1 month ago
JSON representation
A comprehensive Spring backend API designed for seamless point-of-sale management.
- Host: GitHub
- URL: https://github.com/nethmiumaya/spring-pos-backend
- Owner: nethmiumaya
- License: mit
- Created: 2024-10-07T05:25:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-15T17:09:39.000Z (over 1 year ago)
- Last Synced: 2025-01-31T09:18:03.113Z (over 1 year ago)
- Topics: logback, restful-api, spring
- Language: Java
- Homepage:
- Size: 85 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Spring POS Backend
## Introduction
A Point of Sale (POS) system is a combination of hardware and software used by businesses to process sales transactions, manage inventory, track customer data, and generate reports. It typically includes components like a cash register, barcode scanner, receipt printer, and a payment terminal, all integrated into a software platform that streamlines retail operations.
### Technologies Used
- **Backend:** Spring Boot, Hibernate, JPA
- **Frontend:** HTML, CSS, JavaScript
- **Database:** MySQL
- **Database Connectivity:** JNDI
## Installation
### Prerequisites
- Java 17 (OpenJDK 17)
- Maven
- MySQL
- Apache Tomcat 10
- Spring Data JPA
- Lombok
### Features
- Sales Management: Quickly process transactions.
- Inventory Tracking: Monitor stock and manage products.
- Customer Management: Keep customer records and history.
- Database Integration: Use MySQL for reliable data storage.
- REST API with JSON responses.
- Set Logging: Integrated logging for tracking events and debugging.
- Exception handling and validation using Spring Validator.
This project demonstrates a cohesive integration of backend technologies, along with robust database management, to create a functional and efficient POS system tailored for pos system.
## API Documentation
You can find the detailed API documentation [API Documentation](https://documenter.getpostman.com/view/35386291/2sAXxTcAa3).
## API Endpoints
Here is a brief description of the available API endpoints:
### Customer Endpoints
- **POST /customer**: Add a new customer. Requires a JSON object with customer details. Returns the added customer object.
- **GET /customer/{id}**: Retrieve a specific customer's details by ID. No parameters required. Returns the customer object.
- **PUT /customer/{id}**: Update a customer by ID. Requires a JSON object with updated customer details. Returns the updated customer object.
- **DELETE /customer/{id}**: Delete a customer by ID. No parameters required. Returns a success message.
### Item Endpoints
- **GET /item**: Fetch all items or a specific item by code. No parameters required. Returns a JSON array of item objects.
- **POST /item**: Add a new item. Requires a JSON object with item details. Returns the added item object.
- **PUT /item/{id}**: Update an item by ID. Requires a JSON object with updated item details. Returns the updated item object.
- **DELETE /item/{id}**: Delete an item by ID. No parameters required. Returns a success message.
### Order Endpoints
- **GET /orders**: Retrieve all orders. Returns a JSON array of order objects.
- **POST /orders**: Create a new order. Requires a JSON object with order details. Returns the created order object.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for more details.
© 2024 Nethmi Umaya