# Xpeditis — Documentation

Documentation complète de la plateforme B2B SaaS de réservation de fret maritime.

---

## Démarrage rapide

| Objectif | Fichier |
|---|---|
| Démarrer en 5 minutes | [getting-started/quick-start.md](getting-started/quick-start.md) |
| Installation détaillée | [getting-started/installation.md](getting-started/installation.md) |
| Windows | [getting-started/windows.md](getting-started/windows.md) |

---

## Architecture

| Sujet | Fichier |
|---|---|
| Vue d'ensemble système | [architecture/overview.md](architecture/overview.md) |
| Schéma base de données | [architecture/database.md](architecture/database.md) |
| Backend (NestJS hexagonal) | [architecture/backend.md](architecture/backend.md) |
| Frontend (Next.js 14) | [architecture/frontend.md](architecture/frontend.md) |

---

## Fonctionnalités

| Fonctionnalité | Fichier |
|---|---|
| Recherche de tarifs (FCL + CSV) | [features/rate-search.md](features/rate-search.md) |
| Réservation standard | [features/bookings.md](features/bookings.md) |
| Réservation CSV + Portail Carrier | [features/csv-bookings.md](features/csv-bookings.md) |
| Authentification & RBAC | [features/auth.md](features/auth.md) |
| Abonnements Stripe | [features/subscriptions.md](features/subscriptions.md) |
| Notifications temps réel | [features/notifications.md](features/notifications.md) |
| Accès API (clés API) | [features/api-access.md](features/api-access.md) |
| Système CSV | [../csv-system/CSV_RATE_SYSTEM.md](../csv-system/CSV_RATE_SYSTEM.md) |

---

## Déploiement

| Sujet | Fichier |
|---|---|
| Portainer / Docker Swarm | [deployment/portainer.md](deployment/portainer.md) |
| Hetzner / Kubernetes | [deployment/hetzner/README.md](deployment/hetzner/README.md) |
| Stripe (paiements) | [deployment/STRIPE_SETUP.md](deployment/STRIPE_SETUP.md) |

---

## Tests

| Sujet | Fichier |
|---|---|
| Guide tests (unité, intégration, E2E) | [testing/TEST_EXECUTION_GUIDE.md](testing/TEST_EXECUTION_GUIDE.md) |
| Tests locaux | [testing/LOCAL_TESTING.md](testing/LOCAL_TESTING.md) |
| Tests manuels | [testing/MANUAL_TEST_INSTRUCTIONS.md](testing/MANUAL_TEST_INSTRUCTIONS.md) |
| Postman | [testing/GUIDE_TESTS_POSTMAN.md](testing/GUIDE_TESTS_POSTMAN.md) |
| Couverture | [testing/TEST_COVERAGE_REPORT.md](testing/TEST_COVERAGE_REPORT.md) |

---

## Portail Carrier

| Sujet | Fichier |
|---|---|
| Recherche API carriers | [carrier-portal/CARRIER_API_RESEARCH.md](carrier-portal/CARRIER_API_RESEARCH.md) |
| Plan d'implémentation | [carrier-portal/CARRIER_PORTAL_IMPLEMENTATION_PLAN.md](carrier-portal/CARRIER_PORTAL_IMPLEMENTATION_PLAN.md) |

---

## Archives

Les rapports de sprint et notes de debug sont archivés dans [archive/](archive/).

---

## Pour les développeurs

### Lire dans cet ordre

1. [getting-started/quick-start.md](getting-started/quick-start.md) — démarrer le projet
2. `CLAUDE.md` à la racine — **architecture hexagonale, règles et conventions**
3. [architecture/overview.md](architecture/overview.md) — vision système
4. [architecture/database.md](architecture/database.md) — schéma BDD complet

### Commandes essentielles

```bash
# Infrastructure
docker-compose up -d

# Démarrer
npm run backend:dev    # http://localhost:4000 — Swagger: /api/docs
npm run frontend:dev   # http://localhost:3000

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

# Migrations
cd apps/backend && npm run migration:run
```
