🎉 Bienvenue dans FreeTrade
Découvrez FreeTrade - l'API Gateway OFR complète et professionnelle pour la gestion des transports et du commerce.
🌟 Vue d'ensemble
FreeTrade est une architecture microservices révolutionnaire qui centralise l'accès à tous les services du système OFR. Elle offre une solution complète pour :
- 🔐 Authentification et autorisation avancées
- 👥 Gestion des acteurs (Administrateurs, Agents, Clients)
- 🚛 Gestion des transports et véhicules
- 📋 Système de plaintes complet
- 💬 Forum communautaire avec modération
- 📢 Annonces et communications
✨ Fonctionnalités principales
🏗️ Architecture Microservices
- 163 endpoints opérationnels
- 14 modules fonctionnels
- Communication NATS pour la scalabilité
- Cache Redis intelligent pour les performances
🛡️ Sécurité de niveau production
- Authentification JWT avec cache intelligent
- AuthGuard avancé avec enrichissement des requêtes
- Validation stricte des données
- Gestion granulaire des erreurs
📊 Modules complets
- 8 modules Admin (115 endpoints)
- 5 modules Trade (46 endpoints)
- Module Auth optimisé (2 endpoints)
🚀 Démarrage rapide
Prérequis
Installation rapide
# Cloner le projet
git clone https://github.com/OFR/freetrade-docs.git
cd freetrade-docs
# Installer les dépendances
npm install
# Démarrer l'écosystème complet
./start-services.sh -a
Accès aux services
- API Gateway : http://localhost:3004
- Documentation : http://localhost:3000
- Admin DB : http://localhost:8080
📚 Navigation de la documentation
Cette documentation est organisée en trois sections principales :
📖 Documentation
- Guide de démarrage et concepts fondamentaux
- Architecture et design patterns
- Modules métier et fonctionnalités
🔌 API Reference
- Référence complète des endpoints
- Exemples de requêtes et réponses
- Codes d'erreur et gestion
🚀 Déploiement
- Configuration et installation
- Déploiement en production
- Monitoring et maintenance
🎯 Prochaines étapes
- Guide de démarrage - Commencez ici pour une vue d'ensemble
- Architecture - Comprenez l'architecture du système
- API Reference - Explorez les endpoints disponibles
- Déploiement - Déployez FreeTrade en production
FreeTrade est prêt pour la production avec une architecture scalable, une sécurité renforcée et une documentation complète ! 🚀