Logistics Platform API

A Spring Boot and PostgreSQL based backend for managing logistics operations including locations, storage units, products, routes, and demands.

---

1. Documentation

Resource	Description	View Link
Swagger UI	Swagger API Docs	Explore Docs
Postman	Postman API collection	View Collection
Architecture	System Architecture	View Design
DB Design	Entity-Relationship Diagram	View Schemas
Validation	Sequence Digram for Full Logistics Validation	View Sequence Diagram

2. Tech Stack

Component	Technologies
Backend	Java 21 (Temurin), Spring Boot 3.5.10
Data Access	Spring Data JPA (Hibernate)
Database	PostgreSQL 15
Containerization	Docker, Docker Compose
CI/CD	GitHub Actions
Deployment	Render (Managed Cloud)

---

3. Quick Start (Local Run)

Get the entire system up and running in minutes using Docker:

1. Clone the repository

   git clone https://github.com/alamgir-ahosain/logistics-platform.git

2. Navigate to the project directory

   cd logistics-platform

3. Spin up the containers

   docker compose up --build -d

The API will be available at http://localhost:8000

---

4. Local Setup (Without Docker)

If prefer to configure the environment manually or run the application without Docker, follow these steps:

1. Clone the Repository

   git clone https://github.com/alamgir-ahosain/logistics-platform.git
   cd logistics-platform

2. Environment Configuration

   Create a .env file in the server/ directory. This project uses java-dotenv to load credentials securely.

   DB_HOST=
   DB_PORT=
   DB_NAME=
   DB_USER=
   DB_PASSWORD=

   Do NOT commit .env Put it in .gitingore

3. Build the Project

   Ensure JDK 21 is installed. Use the Maven wrapper to install dependencies:

   cd server
   ./mvnw clean install

4. Run the Application

   Start the Spring Boot server:

   ./mvnw spring-boot:run

5. Access the Application

   The API will be available at: http://localhost:8000/

---

5. Project Structure

├── server/                 # Spring Boot Application
│   ├── src/                # Source code
│   ├── Dockerfile          # Production Docker build
│   └── .env                # Environment variable template
├── database/               # SQL scripts
│   └── Init.sql            # Initial schema
└── docker-compose.yml      # Local development setup

6. System Architecture

7. Database Design

8.Logistics Validation