xpeditis2.0/INDEX.md

📑 Xpeditis Documentation Index

Complete guide to all documentation files in the Xpeditis project.

---

🚀 Getting Started (Read First)

Start here if you're new to the project:

1. README.md - Project overview and quick start
2. QUICK-START.md ⚡ - Get running in 5 minutes
3. INSTALLATION-STEPS.md - Detailed installation guide
4. NEXT-STEPS.md - What to do after setup

---

📊 Project Status & Planning

Sprint 0 (Complete ✅)

• SPRINT-0-FINAL.md - Complete Sprint 0 report

  • All deliverables
  • Architecture details
  • How to use
  • Success criteria

• SPRINT-0-SUMMARY.md - Executive summary

  • Objectives achieved
  • Metrics
  • Key features
  • Next steps

• SPRINT-0-COMPLETE.md - Technical completion checklist

  • Week-by-week breakdown
  • Files created
  • Remaining tasks

Project Roadmap

• TODO.md 📅 - 30-week MVP development roadmap

  • Sprint-by-sprint breakdown
  • Detailed tasks with checkboxes
  • Phase 1-4 planning
  • Go-to-market strategy

• PRD.md 📋 - Product Requirements Document

  • Business context
  • Functional specifications
  • Technical requirements
  • Success metrics

---

🏗️ Architecture & Development Guidelines

Core Architecture

• CLAUDE.md 🏗️ - START HERE FOR ARCHITECTURE
  • Complete hexagonal architecture guide
  • Domain/Application/Infrastructure layers
  • Ports & Adapters pattern
  • Naming conventions
  • Testing strategy
  • Common pitfalls
  • Complete examples (476 lines)

Component-Specific Documentation

• apps/backend/README.md - Backend (NestJS + Hexagonal)

  • Architecture details
  • Available scripts
  • API endpoints
  • Testing guide
  • Hexagonal architecture DOs and DON'Ts

• apps/frontend/README.md - Frontend (Next.js 14)

  • Tech stack
  • Project structure
  • API integration
  • Forms & validation
  • Testing guide

---

🛠️ Technical Documentation

Configuration Files

Root Level:

• package.json - Workspace configuration
• .gitignore - Git ignore rules
• .prettierrc - Code formatting
• docker-compose.yml - PostgreSQL + Redis
• tsconfig.json - TypeScript configuration (per app)

Backend (apps/backend/):

• package.json - Backend dependencies
• tsconfig.json - TypeScript strict mode + path aliases
• nest-cli.json - NestJS CLI configuration
• .eslintrc.js - ESLint rules
• .env.example - Environment variables template

Frontend (apps/frontend/):

• package.json - Frontend dependencies
• tsconfig.json - TypeScript configuration
• next.config.js - Next.js configuration
• tailwind.config.ts - Tailwind CSS theme
• postcss.config.js - PostCSS configuration
• .env.example - Environment variables template

CI/CD

GitHub Actions (.github/workflows/):

• ci.yml - Continuous Integration

  • Lint & format check
  • Unit tests (backend + frontend)
  • E2E tests
  • Build verification

• security.yml - Security Audit

  • npm audit
  • Dependency review

Templates:

• .github/pull_request_template.md - PR template with hexagonal architecture checklist

---

📚 Documentation by Use Case

I want to...

...get started quickly

1. QUICK-START.md - 5-minute setup
2. INSTALLATION-STEPS.md - Detailed steps
3. NEXT-STEPS.md - Begin development

...understand the architecture

1. CLAUDE.md - Complete hexagonal architecture guide
2. apps/backend/README.md - Backend specifics
3. SPRINT-0-FINAL.md - See what's implemented

...know what to build next

1. TODO.md - Full roadmap
2. NEXT-STEPS.md - Immediate next tasks
3. PRD.md - Business requirements

...understand the business context

1. PRD.md - Product requirements
2. README.md - Project overview
3. SPRINT-0-SUMMARY.md - Executive summary

...fix an installation issue

1. INSTALLATION-STEPS.md - Troubleshooting section
2. QUICK-START.md - Common issues
3. README.md - Basic setup

...write code following best practices

1. CLAUDE.md - Architecture guidelines (READ THIS FIRST)
2. apps/backend/README.md - Backend DOs and DON'Ts
3. TODO.md - Task specifications and acceptance criteria

...run tests

1. apps/backend/README.md - Testing section
2. apps/frontend/README.md - Testing section
3. CLAUDE.md - Testing strategy

...deploy to production

1. SPRINT-0-FINAL.md - Security checklist
2. apps/backend/.env.example - All required variables
3. .github/workflows/ci.yml - CI/CD pipeline

---

📖 Documentation by Role

For Developers

Must Read:

1. CLAUDE.md - Architecture principles
2. apps/backend/README.md OR apps/frontend/README.md
3. TODO.md - Current sprint tasks

Reference:

• INSTALLATION-STEPS.md - Setup issues
• PRD.md - Business context

For Architects

Must Read:

1. CLAUDE.md - Complete architecture
2. SPRINT-0-FINAL.md - Implementation details
3. PRD.md - Technical requirements

Reference:

• TODO.md - Technical roadmap
• apps/backend/README.md - Backend architecture

For Project Managers

Must Read:

1. SPRINT-0-SUMMARY.md - Status overview
2. TODO.md - Complete roadmap
3. PRD.md - Requirements & KPIs

Reference:

• SPRINT-0-FINAL.md - Detailed completion report
• README.md - Project overview

For DevOps

Must Read:

1. INSTALLATION-STEPS.md - Setup guide
2. docker-compose.yml - Infrastructure
3. .github/workflows/ - CI/CD pipelines

Reference:

• apps/backend/.env.example - Environment variables
• SPRINT-0-FINAL.md - Security checklist

---

🗂️ Complete File List

Documentation (11 files)

File	Purpose	Length
README.md	Project overview	Medium
CLAUDE.md	Architecture guide	Long (476 lines)
PRD.md	Product requirements	Long (352 lines)
TODO.md	30-week roadmap	Very Long (1000+ lines)
QUICK-START.md	5-minute setup	Short
INSTALLATION-STEPS.md	Detailed setup	Medium
NEXT-STEPS.md	What's next	Medium
SPRINT-0-FINAL.md	Sprint 0 report	Long
SPRINT-0-SUMMARY.md	Executive summary	Medium
SPRINT-0-COMPLETE.md	Technical checklist	Short
INDEX.md	This file	Medium

App-Specific (2 files)

File	Purpose
apps/backend/README.md	Backend guide
apps/frontend/README.md	Frontend guide

Configuration (10+ files)

Root, backend, and frontend configuration files (package.json, tsconfig.json, etc.)

---

📊 Documentation Statistics

• Total Documentation Files: 13
• Total Lines: ~4,000+
• Coverage: Setup, Architecture, Development, Testing, Deployment
• Last Updated: October 7, 2025

---

🎯 Recommended Reading Path

For New Team Members (Day 1)

Morning (2 hours):

1. README.md - 10 min
2. QUICK-START.md - 30 min (includes setup)
3. CLAUDE.md - 60 min (comprehensive architecture)
4. PRD.md - 20 min (business context)

Afternoon (2 hours): 5. apps/backend/README.md OR apps/frontend/README.md - 30 min 6. TODO.md - Current sprint section - 30 min 7. NEXT-STEPS.md - 30 min 8. Start coding! 🚀

For Code Review (30 minutes)

1. CLAUDE.md - Hexagonal architecture section
2. apps/backend/README.md - DOs and DON'Ts
3. TODO.md - Acceptance criteria for the feature

For Sprint Planning (1 hour)

1. TODO.md - Next sprint tasks
2. PRD.md - Requirements for the module
3. SPRINT-0-SUMMARY.md - Current status

---

🔍 Quick Reference

Common Questions

Q: How do I get started? A: QUICK-START.md

Q: What is hexagonal architecture? A: CLAUDE.md - Complete guide with examples

Q: What should I build next? A: NEXT-STEPS.md then TODO.md

Q: How do I run tests? A: apps/backend/README.md or apps/frontend/README.md

Q: Where are the business requirements? A: PRD.md

Q: What's the project status? A: SPRINT-0-SUMMARY.md

Q: Installation failed, what do I do? A: INSTALLATION-STEPS.md - Troubleshooting section

Q: Can I change the database/framework? A: Yes! That's the point of hexagonal architecture. See CLAUDE.md

---

📞 Getting Help

If you can't find what you need:

1. Check this index - Use Ctrl+F to search
2. Read CLAUDE.md - Covers 90% of architecture questions
3. Check TODO.md - Has detailed task specifications
4. Open an issue - If documentation is unclear or missing

---

🎉 Happy Reading!

All documentation is up-to-date as of Sprint 0 completion.

Quick Links:

• 🚀 Get Started
• 🏗️ Architecture
• 📅 Roadmap
• 📋 Requirements

---

Xpeditis MVP - Maritime Freight Booking Platform Documentation Index - October 7, 2025