Repository navigation
Development Guide
github-actions[bot] edited this page Nov 14, 2026
·
3 revisions
This guide is the primary walkthrough for setting up, developing, testing, and contributing to the Atlas Logistics platform.
-
Node.js:
v22.x(LTS recommended) orv24.x -
Package Manager:
pnpm(Corepack enabled:corepack enable pnpm) -
Database: Embedded SQLite (
data/dev.db, no external DB server required for development) - Optional: Docker Desktop (for Redis or Observability profile)
# 1. Clone repository
git clone https://github.com/xpallares1987-ai/Atlas-Logistics.git
cd Atlas-Logistics
# 2. Install dependencies with pnpm
pnpm install
# 3. Initialize environment file (.env.local)
cp .env.example .env.local
# 4. Apply database migrations and seed baseline data
pnpm run db:migrate
pnpm run db:seed
# 5. Verify DDL Parity, Leak Prevention Guard & Code Quality
pnpm run audit:ddl-drift
pnpm run audit:leaks:staged
pnpm run lint
npx tsc --noEmit-
Terminal 1: Backend Fastify API
pnpm dev:backend # Listens on http://localhost:3001 -
Terminal 2: Frontend PWA Host (React 19 + Vite)
pnpm dev:frontend # Listens on http://localhost:3000
pnpm dev| Command | Purpose | When to Run |
|---|---|---|
pnpm test |
Run all unit & integration test suites across the repository | Prior to commits |
pnpm vitest run tests/scm-* |
Run SCM domain control engine test suites | SCM development |
pnpm run audit:ddl-drift |
Validate Drizzle snapshot parity and replay integrity | Schema changes |
pnpm run check:file-sizes |
Enforce <1,000 line modularity guardrail on page modules | Frontend changes |
pnpm run lint |
Run ESLint across root and monorepo packages | Prior to commits |
npx tsc --noEmit |
Strict TypeScript compiler check across workspaces | Prior to commits |
pnpm run audit:leaks:staged |
Scan staged files for confidential partner identifiers | Pre-commit hook & CI |
npx playwright test |
Run end-to-end browser test suites | Pre-release |
The repository is configured with husky and lint-staged:
- On
git commit(mandatory signed with-S), the pre-commit hook automatically executes:-
scripts/check-sensitive-leaks.cjs --staged(Zero-leak policy) -
eslint --fixon staged files -
prettier --writeon staged files
-
Atlas Logistics · Enterprise Multimodal Logistics & Freight Forwarding Operating System
Main Repository: xpallares1987-ai/Atlas-Logistics · Licensed Documentation