https://github.com/sandundil2002/spring_pos_api
This Point of Sale (POS) system is built with Spring framework to manage customer data, inventory, and orders in a retail environment. It offers a user-friendly interface for adding customers, managing items, and processing transactions, enhancing operational efficiency and the retail experience.
https://github.com/sandundil2002/spring_pos_api
java jpa-hibernate logger mysql point-of-sale rest-api spring
Last synced: 2 months ago
JSON representation
This Point of Sale (POS) system is built with Spring framework to manage customer data, inventory, and orders in a retail environment. It offers a user-friendly interface for adding customers, managing items, and processing transactions, enhancing operational efficiency and the retail experience.
- Host: GitHub
- URL: https://github.com/sandundil2002/spring_pos_api
- Owner: sandundil2002
- License: mit
- Created: 2024-10-04T06:20:25.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-16T08:28:30.000Z (over 1 year ago)
- Last Synced: 2025-04-07T00:52:23.423Z (about 1 year ago)
- Topics: java, jpa-hibernate, logger, mysql, point-of-sale, rest-api, spring
- Language: Java
- Homepage:
- Size: 131 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Spring POS API
The Spring POS API is a comprehensive Point of Sale system built using the Spring Framework to manage customer data items and orders in a real-time retail environment. It enables efficient sales transactions inventory tracking and customer management with robust data handling via Spring Data JPA and Hibernate ORM. Designed for flexibility and scalability this API supports seamless integration with various front-end systems and offers well-documented RESTful endpoints for easy customization and extension making it an ideal solution for small to medium-sized businesses.
🧐 Features
Here're some of the project's best features:
* Manage customers items and orders.
* Real-time inventory management.
* Order creation with payment methods (cash/card/mobile).
* Database: MySQL with Hibernate ORM.
* Exception handling and validation using Spring Validator.
* REST API with JSON responses.
🛠️ Installation Steps:
1. Clone the Repository
```
git clone https://github.com/sandundil2002/Spring_POS_API.git
```
2. Build and Run the Application
```
mvn clean install
```
3. The application will start on
```
http://localhost:8080
```
API Endpoints
Customer Endpoints
* GET /customer: Retrieve all customers.
* POST /customer: Create a new customer.
* PUT /customer: Update an existing customer.
* DELETE /customer/{id}: Delete a customer by ID.
Item Endpoints
* GET /item: Retrieve all items.
* POST /item: Create a new item.
* PUT /item: Update an existing item.
* DELETE /item/{id}: Delete an item by ID.
Order Endpoints
* POST /order: Create a new order.
💻 Built with
Technologies used in the project:
* Spring- Backend framework in java
* Hibernate- ORM for database interaction
* Spring Data JPA- Data repository layer
* MySQL- Database
* Lombok- To reduce boilerplate code
API Documentation
* You can view the detailed API documentation with example requests and responses here.
Frontend Repository
* For the frontend implementation of this project, you can visit the repository Spring POS Frontend
🛡️ License:
This project is licensed under the MIT License - see the LICENSE file for details.