Documentation BCard¶
Documentation technique de la plateforme BCard. Pour l'installation et le démarrage rapide, voir Installation.
| Document | Contenu |
|---|---|
| installation.md | Mise en place d'un environnement BCard fonctionnel, en local ou avec Docker |
| configuration.md | Variables d'environnement lues par BCard, section par section |
| contribuer.md | Branches, commits, conventions de code, checklist de merge request |
| architecture.md | Modèle de données, rôles applicatifs, organisation du code, parcours métier |
| base-de-donnees.md | Connexion, répartition des entités du domaine, migrations et jeux de données de développement |
| securite.md | Authentification, autorisation et traçabilité : pare-feux, JWT, vérification d'e-mail, audit |
| cartes-et-qrcodes.md | Génération technique d'une carte de visite numérique et de son QR code |
| paiements.md | Offres d'abonnement, moyens de paiement, intégration et webhooks Stripe |
| back-office.md | Modules du back-office et rôles associés |
| api.md | API REST : authentification JWT, contrôle d'accès, catalogue des endpoints |
| services.md | Classes de src/Service portant la logique métier, regroupées par domaine fonctionnel |
| deploiement.md | Construction de l'image Docker, déploiement en production, diagnostic |
| tests-et-qualite.md | Exécution des tests et outils de qualité de code |
| generer-la-doc.md | Génération phpDocumentor, portail documentaire et conventions de docblock |
Documentation générée¶
| Source | Accès |
|---|---|
| API REST (Swagger UI) | /api/docs sur l'application en fonctionnement |
| Spécification OpenAPI | /api/doc.json |
| Référence du code (phpDocumentor) | onglet Référence du code du portail, ou docs/api-reference/index.html |
Le répertoire docs/api-reference/ est généré et non versionné.
Ce portail se consulte en local avec :