Julien Martin
48b01ed3fe
- Création du dossier docs/ pour centraliser la documentation - Ajout de API.md : documentation complète de tous les endpoints - Ajout de DATABASE.md : schéma complet de la base de données - Ajout de AUDIT.md : audit du projet YNOV - Déplacement des README-ARCHITECTURE.md et README-DEPLOYMENT.md vers docs/ - Ajout d'un README.md index dans docs/
1.6 KiB
1.6 KiB
📚 Documentation PtitsPas App
Bienvenue dans la documentation complète de l'application PtitsPas.
📖 Table des matières
Architecture & Infrastructure
- Architecture - Vue d'ensemble de l'architecture mono-repo et multi-conteneurs
- Déploiement - Guide complet de déploiement et configuration CI/CD
Développement
- API Documentation - Documentation complète des endpoints REST
- Database Schema - Schéma de la base de données et modèles
- Workflow de développement - Process Git, branches et déploiement
Administration
- Guide d'administration - Gestion des utilisateurs, accès PgAdmin, logs
- Troubleshooting - Résolution des problèmes courants
Audit & Analyse
- Audit du projet YNOV - Analyse complète du code étudiant et fonctionnalités
Frontend
- Frontend Flutter - Structure de l'application mobile/web
🚀 Quick Start
# Cloner le projet
git clone ssh://gitea-jmartin/jmartin/app.git ptitspas-app
# Lancer l'environnement de développement
cd ptitspas-app
docker compose up -d
# Accéder aux services
Frontend: https://app.ptits-pas.fr
API: https://app.ptits-pas.fr/api
PgAdmin: https://app.ptits-pas.fr/pgadmin
🔗 Liens utiles
- Gitea : https://git.ptits-pas.fr
- Production : https://app.ptits-pas.fr
- Mail : https://mail.ptits-pas.fr
📝 Maintenance
Cette documentation est maintenue par Julien Martin (julien.martin@ptits-pas.fr).
Dernière mise à jour : Novembre 2025