Lift Nexus API Documentation¶
Lift Nexus API is a Spring Boot backend MVP for warehouse dispatch optimization.
It models a simplified warehouse scenario with forklifts, load units, storage bins, and transport orders. The current MVP focuses on static dispatching: creating a warehouse state, starting a one-shot optimization job, and assigning transport orders to forklifts using Timefold Solver.
Project status
This is a portfolio / learning project, not a production warehouse management system yet.
What this documentation covers¶
-
Project Overview
Why the project exists, what problem it models, and what is currently implemented.
-
Architecture
Current architecture decisions, module boundaries, and why the project uses a modular monolith.
-
Domain Model
Explanation of forklifts, load units, storage bins, transport orders, and dispatch jobs.
-
Optimization Approach
How Timefold is used, what gets optimized, and how hard and soft constraints are structured.
-
API Usage
How to run the application, create data, start a dispatch job, and inspect the result.
-
Testing Strategy
Unit tests, integration tests with PostgreSQL/Testcontainers, coverage, and code quality checks.
-
Known Limitations
Current MVP limitations, simplifications, and technical areas that still need improvement.
-
Roadmap
Milestones from static dispatching toward dynamic dispatching, stronger constraints, and deployment readiness.
Generated reports¶
These reports are generated from the build pipeline: