{"id":18153227,"url":"https://github.com/charakamihiranga/spring-pos-api","last_synced_at":"2026-05-09T19:05:31.411Z","repository":{"id":258652495,"uuid":"871075633","full_name":"charakamihiranga/Spring-POS-API","owner":"charakamihiranga","description":"RESTful backend for a Point of Sale system developed using the Spring Framework.","archived":false,"fork":false,"pushed_at":"2024-10-17T16:05:12.000Z","size":196,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-16T10:30:53.294Z","etag":null,"topics":["mysql","pos-api","restful-api","sl4j-logback","spring","spring-mysql"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/charakamihiranga.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-11T08:15:09.000Z","updated_at":"2024-12-05T02:17:30.000Z","dependencies_parsed_at":"2024-10-20T01:33:37.161Z","dependency_job_id":"6c85e18e-b171-4472-af74-c8925351f905","html_url":"https://github.com/charakamihiranga/Spring-POS-API","commit_stats":null,"previous_names":["charakamihiranga/spring-pos-api","charakagamage/spring-pos-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charakamihiranga%2FSpring-POS-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charakamihiranga%2FSpring-POS-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charakamihiranga%2FSpring-POS-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charakamihiranga%2FSpring-POS-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/charakamihiranga","download_url":"https://codeload.github.com/charakamihiranga/Spring-POS-API/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240131770,"owners_count":19752725,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mysql","pos-api","restful-api","sl4j-logback","spring","spring-mysql"],"created_at":"2024-11-02T03:06:04.818Z","updated_at":"2026-05-09T19:05:31.372Z","avatar_url":"https://github.com/charakamihiranga.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Spring POS API\n\nThe **Spring POS API** is a robust backend solution designed for a Point of Sale (POS) system, developed using the **Spring Framework**. It facilitates seamless integration with front-end applications by efficiently managing orders, customers, and inventory through a well-designed API.\n\n## Features\n\n* **RESTful API:**\n   * A comprehensive set of endpoints allows for managing customers, items, and orders.\n   * Adheres to standard HTTP methods (GET, POST, PUT, DELETE) to ensure intuitive integration with any front-end application.\n* **Layered Architecture:**\n   * Utilizes a well-structured layered architecture that separates concerns into Controller, Service, and DAO layers.\n   * Promotes maintainability and scalability, making future enhancements easier to implement.\n* **Database Integration:**\n   * Employs **MySQL** as the relational database, utilizing **Spring Data JPA** and **Hibernate** for efficient data access and manipulation.\n* **Logging:**\n   * Implements logging via **SLF4J** with **Logback**, supporting various logging levels (INFO, DEBUG, ERROR) for thorough tracking and debugging throughout the application lifecycle.\n* **AJAX Support:**\n   * Supports AJAX for asynchronous data handling, enhancing user experience by allowing operations without full page reloads.\n\n## Tech Stack\n\n* **Framework:** Spring Framework\n* **Database:** MySQL\n* **ORM:** Hibernate (Object-Relational Mapping)\n* **Data Access:** Spring Data JPA\n* **Web Technology:** Spring Web MVC\n* **Logging:** SLF4J with Logback\n* **Mapping:** ModelMapper (for conversion between DTOs and entities)\n\n## Installation\n\n### Prerequisites:\n* **Java 17** or higher\n* **Maven**\n* **MySQL**\n\n### Steps:\n\n1. **Clone the Repository:**\n   ```bash\n   git clone https://github.com/CharakaMihiranga/Spring-POS-API.git\n   cd Spring-POS-API\n   ```\n\n2. **Set Up MySQL Database:**\n   * Create a database named `springpos` using your MySQL client:\n     ```sql\n     CREATE DATABASE springpos;\n     ```\n\n3. **Configure Database Credentials:**\n   * Update the database configuration in the `WebAppRootConfig` class with your specific MySQL credentials and connection URL.\n\n4. **Build the Project:**\n   ```bash\n   mvn clean install\n   ```\n\n5. **Run the Application:**\n   * Deploy the generated WAR file located in the `target` directory to your preferred servlet container (e.g., Tomcat).\n\n## API Documentation\n\nFor detailed information on endpoints, request/response formats, and usage examples, please refer to the API documentation:\n\nhttps://documenter.getpostman.com/view/35384500/2sAXxV7Vvw\n\n## Contributing\n\nContributions are welcome! If you have suggestions for improvements or new features, please open an issue or submit a pull request.\n\n## License\n\nThis project is licensed under the MIT License. See the `LICENSE` file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharakamihiranga%2Fspring-pos-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcharakamihiranga%2Fspring-pos-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharakamihiranga%2Fspring-pos-api/lists"}