Order Collection Management System

Welcome to the Order Collection Management System! This project is a REST API designed to handle the lifecycle of customer orders and payment collections. It is built using Java and the Spring Boot framework, following modern backend architectural patterns.

---

📖 Table of Contents

1. Project Overview
2. Tech Stack
3. Project Structure
4. ERD Diagram
5. Getting Started
6. GitBook Documentation

---

Project Overview

The system allows businesses to:

• Manage Orders: Create, update, and track customer orders.
• Track Collections: Monitor payment statuses and link them to specific orders.
• Customer Management: Maintain records of customers and their order history.
• Data Persistence: Store all information securely in a relational database (PostgreSQL).

---

Tech Stack

• Language: Java 21
• Framework: Spring Boot (REST, Hibernate, Data JPA, Security)
• Build Tool: Maven
• Database: PostgreSQL
• Tools: IntelliJ IDEA, Git
• Documentation: GitBook
• Endpoints Testing: Postman

---

Project Structure

Based on the project design, the code is organized into a layered architecture to ensure separation of concerns:

src/main/java/com/yourname/ordercollection/
│
├── controller/      # REST API Endpoints (Handles HTTP requests)
├── service/         # Business Logic (Calculations, rules, and workflows)
├── repository/      # Data Access Layer (Interfaces for DB communication)
├── entity/          # Database Models (JPA Entities mapping to SQL tables)
├── dto/             # Data Transfer Objects (For structured API responses)
├── request/         # request dtos
└── config/          # Security and Bean configurations

ERD Diagram

https://drawsql.app/teams/backend-150/diagrams/ocms

---

Getting Started

Prerequisites

• JDK 21 or higher.
• IntelliJ IDEA (Community or Ultimate).
• Maven (included in IntelliJ).
• Postgres installed locally

Installation

1. Clone the repository:

git clone https://github.com/phonewinttun-dev/Order-Collection-Management-System.git

2. Configure the Database: Update src/main/resources/application.properties with your database credentials:

spring.datasource.url=jdbc:postgresql://localhost:5432/your_database_name
spring.datasource.username=your_username
spring.datasource.password=your_password

3. Run the Application: Open the project in IntelliJ and run the OrderCollectionApplication.java file.

---

Documentation

Detailed business logic, database ERDs, and API specifications are maintained on GitBook: 🔗 GitBook Documentation

---

Developed with ❤️ by members of Artificial Punks.