69 lines
2.6 KiB
Markdown
69 lines
2.6 KiB
Markdown
# 📚 Index de la Documentation - PtitsPas App
|
|
|
|
Bienvenue dans la documentation complète de l'application PtitsPas.
|
|
|
|
Ce fichier sert d'index pour naviguer dans toute la documentation du projet.
|
|
|
|
## 📖 Table des matières
|
|
|
|
### 📋 Cahier des Charges
|
|
- [**01 - Cahier des Charges**](./01_CAHIER-DES-CHARGES.md) - Cahier des charges complet du projet P'titsPas (V1.3 - 24/11/2025)
|
|
|
|
### Architecture & Infrastructure
|
|
- [**02 - Architecture**](./02_ARCHITECTURE.md) - Vue d'ensemble de l'architecture mono-repo et multi-conteneurs
|
|
- [**03 - Déploiement**](./03_DEPLOYMENT.md) - Guide complet de déploiement et configuration CI/CD
|
|
|
|
### Planification
|
|
- [**04 - Roadmap Générale**](./04_ROADMAP-GENERALE.md) - Roadmap complète du projet (Phases 1 à 5+)
|
|
|
|
### Développement
|
|
- [**10 - Database Schema**](./10_DATABASE.md) - Schéma de la base de données et modèles
|
|
- [**11 - API Documentation**](./11_API.md) - Documentation complète des endpoints REST
|
|
|
|
### Workflows Fonctionnels
|
|
- [**20 - Workflow Création de Compte**](./20_WORKFLOW-CREATION-COMPTE.md) - Workflow complet de création et validation des comptes utilisateurs
|
|
- [**21 - Configuration Système**](./21_CONFIGURATION-SYSTEME.md) - Configuration on-premise dynamique
|
|
- [**22 - Documents Légaux**](./22_DOCUMENTS-LEGAUX.md) - Gestion CGU/Privacy avec versioning
|
|
- [**23 - Liste des Tickets**](./23_LISTE-TICKETS.md) - 61 tickets Phase 1 détaillés
|
|
- [**24 - Décisions Projet**](./24_DECISIONS-PROJET.md) - Décisions architecturales et fonctionnelles
|
|
- [**25 - Backlog Phase 2**](./25_PHASE-2-BACKLOG.md) - Fonctionnalités techniques reportées
|
|
|
|
### Administration (À créer)
|
|
- [**30 - Guide d'administration**](./30_ADMIN.md) - Gestion des utilisateurs, accès PgAdmin, logs
|
|
- [**31 - Troubleshooting**](./31_TROUBLESHOOTING.md) - Résolution des problèmes courants
|
|
|
|
### Frontend (À créer)
|
|
- [**40 - Frontend Flutter**](./40_FRONTEND.md) - Structure de l'application mobile/web
|
|
|
|
### Audit & Analyse
|
|
- [**90 - Audit du projet YNOV**](./90_AUDIT.md) - Analyse complète du code étudiant et fonctionnalités
|
|
|
|
## 🚀 Quick Start
|
|
|
|
```bash
|
|
# 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
|
|
|