Index de documentation — Xpeditis

Démarrage

Fichier	Description
README.md	Vue d'ensemble du projet
QUICK-START.md	Démarrage en 5 minutes
CLAUDE.md	Architecture hexagonale, conventions, règles
docs/README.md	Index complet de la documentation

Documentation complète

Toute la documentation est organisée dans docs/ :

docs/
├── README.md                    # Index principal
├── getting-started/             # Installation et démarrage
│   ├── quick-start.md           # Guide rapide mis à jour
│   ├── installation.md          # Installation détaillée
│   └── windows.md               # Spécifique Windows
│
├── architecture/                # Documentation technique
│   ├── overview.md              # Vue d'ensemble système
│   ├── database.md              # Schéma BDD complet (21 tables)
│   ├── backend.md               # NestJS hexagonal, patterns
│   └── frontend.md              # Next.js 14, App Router, i18n
│
├── features/                    # Documentation par fonctionnalité
│   ├── auth.md                  # Auth JWT/OAuth/API Keys + RBAC
│   ├── bookings.md              # Réservations standard
│   ├── csv-bookings.md          # CSV bookings + portail carrier
│   ├── rate-search.md           # Recherche tarifs FCL + CSV
│   ├── subscriptions.md         # Stripe + abonnements
│   ├── notifications.md         # WebSocket + webhooks
│   └── api-access.md            # Clés API
│
├── deployment/                  # Déploiement
│   ├── portainer.md             # Portainer / Docker Swarm (consolidé)
│   ├── hetzner/                 # Kubernetes Hetzner (15 fichiers numérotés)
│   └── STRIPE_SETUP.md          # Configuration Stripe
│
├── testing/                     # Tests
├── csv-system/                  # Système CSV (format, calcul prix)
├── carrier-portal/              # Portail carrier (recherche API)
├── api-access/                  # Documentation accès API
├── backend/                     # Notes backend (cleanup, MinIO)
└── archive/                     # Rapports de sprint archivés
    ├── phases/                  # Historique phases 1-4
    └── debug/                   # Notes de debug résolues

Commandes essentielles

# Démarrer
docker-compose up -d
npm run install:all
cd apps/backend && npm run migration:run && cd ../..
npm run backend:dev    # http://localhost:4000
npm run frontend:dev   # http://localhost:3000

# Tests
npm run backend:test
npm run frontend:test

# Qualité
npm run format
npm run backend:lint && npm run frontend:lint

Dernière mise à jour : Mai 2026

2.9 KiB Raw Blame History

Index de documentation — Xpeditis

Démarrage

Documentation complète

Commandes essentielles

2.9 KiB

Raw Blame History