Prerequisites
June 14, 2026 ยท View on GitHub
Required software to run LogisticsX locally.
Required Software
.NET 10 SDK
Download and install from Microsoft.
Verify installation:
dotnet --version
# Should output: 10.0.x
Bun Runtime
Required for the Angular frontend applications.
Windows (PowerShell):
irm bun.sh/install.ps1 | iex
macOS/Linux:
curl -fsSL https://bun.sh/install | bash
Verify installation:
bun --version
PostgreSQL 18
Download from PostgreSQL.
Windows: Use the installer, remember the password you set for postgres user.
macOS (Homebrew):
brew install postgresql@18
brew services start postgresql@18
Ubuntu/Debian:
sudo apt install postgresql postgresql-contrib
sudo systemctl start postgresql
Verify installation:
psql --version
Docker (Optional)
Required only for the Docker-based local development setup.
Download Docker Desktop for Windows/macOS, or install Docker Engine on Linux.
Verify installation:
docker --version
docker compose version
Optional Software
IDE Recommendations
| IDE | Best For |
|---|---|
| VS Code | Lightweight, Angular development |
| JetBrains Rider | Cross-platform .NET development |
| Android Studio | Driver mobile app (Kotlin) |
VS Code Extensions
For the best experience with VS Code:
- C# Dev Kit
- Angular Language Service
- ESLint
- Prettier
- Docker
- PostgreSQL (by Chris Kolkman)
Database Tools
- pgAdmin 4: Included with PostgreSQL, or download separately
- DBeaver: Free universal database tool
- DataGrip: JetBrains commercial tool
System Requirements
| Component | Minimum | Recommended |
|---|---|---|
| CPU | 4 cores | 8 cores |
| RAM | 8 GB | 16 GB |
| Storage | 20 GB free | 50 GB SSD |
| OS | Windows 10, macOS 12, Ubuntu 22.04 | Latest versions |
Port Requirements
Ensure these ports are available:
| Port | Service |
|---|---|
| 5432 | PostgreSQL |
| 7000 | API |
| 7001 | Identity Server |
| 7002 | Admin Portal |
| 7003 | TMS Portal |
| 7004 | Customer Portal |
| 7005 | Website |
Check port availability:
Windows:
netstat -an | findstr "7000 7001 7002 7003"
macOS/Linux:
lsof -i :7000,:7001,:7002,:7003
Next Steps
- Local Development - Manual setup without Docker
- Docker Development - Run with Docker