Bienvenue
Cette documentation explique tout ce qui fait tourner TimeManager : le site web, l'API, l'application mobile et l'infrastructure. Elle est écrite pour quelqu'un qui arrive sur le projet sans rien connaître. Chaque outil est présenté avant d'être utilisé, et chaque terme technique est défini dans le glossaire.
Par où commencer
Si tu découvres le projet, lis dans cet ordre :
- Le projet en une page : ce que fait l'application et pour qui.
- Architecture globale : les quatre parties et comment elles se parlent.
- Le dépôt Git : où se trouve quoi dans le code.
- La partie qui te concerne :
Qui s'occupe de quoi
| Partie | Dossier | Responsable |
|---|---|---|
| Frontend | timemanager-web/ | Patrice Dagbe |
| Backend | timemanager-api/ | Patrice Dagbe, Jean-Baptiste Viossi |
| Cybersécurité | timemanager-docs/cybersecurite/ | Jean-Baptiste Viossi |
| Mobile | timemanager-mobile/ | Elias Hounnou |
| DevOps | timemanager-devops/ | Elias Hounnou |
Le détail, et qui contacter pour quoi, est sur la page L'équipe.
Chacun écrit la documentation de sa partie. Les pages Frontend et Backend contiennent un plan à compléter.
Comment lire les schémas
Les schémas sont dessinés avec Mermaid. Une flèche A --> B veut toujours dire « A utilise B » ou « A envoie vers B ». Les cylindres représentent des bases de données ou des services extérieurs.
Lancer cette documentation
La documentation est elle-même un petit site, construit avec VitePress, le générateur de documentation de l'écosystème Vue. Les pages sont de simples fichiers Markdown dans timemanager-docs/.
cd timemanager-docs
npm install
npm run dev # ouvre http://localhost:5173
npm run build # produit le site statique dans .vitepress/distPour ajouter une page : crée un fichier .md dans le bon dossier, puis ajoute-le à la barre latérale dans timemanager-docs/.vitepress/config.mts.
Les documents du projet
Le dossier docs/ à la racine contient les documents de gestion de projet, qui ne font pas partie de ce site :
| Fichier | Contenu |
|---|---|
docs/specifications.md | Le cahier des charges fonctionnel (version 1.7, français et anglais) |
docs/conformity-audit.md | L'audit de conformité du code par rapport aux spécifications |
docs/database.mmd | Le schéma de la base de données, au format Mermaid |
docs/stakeholders.md | Les parties prenantes |
docs/communication-plan.md | Le plan de communication |