DOC.md 3.1 KB

Audit Express Self — Documentation

Quiz diagnostic "contrôle technique" (20 questions, ~7 min). Stack : HTML/CSS/JS + PHP.


1. Démarrage rapide (local)

Prérequis

  • PHP 8.1+
  • Composer : getcomposer.org — installer globalement ou télécharger composer.phar dans le projet

Commandes

composer install --ignore-platform-req=ext-mbstring
php -S 127.0.0.1:8000 -t public

→ Ouvrir http://localhost:8000

Sans Composer global : php composer.phar install ...


2. Structure du projet

audit express self/
├── config/           Configuration + packs JSON
├── src/              Classes PHP (Engine, PdfRenderer, etc.)
├── vendor/           Dépendances (Composer)
├── storage/          Données générées (emails, stats, rate limit)
├── templates/        Modèle HTML du PDF
├── public/           ← Racine web (ce que le navigateur voit)
│   ├── index.php
│   ├── api/
│   └── assets/
├── docs/             Documentation
├── modx/             Intégration MODX (optionnel)
├── composer.json
└── README.md

3. Configuration

  • config.php : valeurs par défaut
  • config.local.php : surcharges (booking_url, devis_url, webhook) — à créer à partir de config.local.example.php
  • config.local.php est ignoré par Git (ne pas le commiter)

4. Déploiement manuel (FileZilla)

Prérequis

  • Compte FTP OVH (host, user, password)
  • config.local.php créé sur le serveur (une seule fois)

Process

  1. Versionner : git add . → git commit -m "..." → git push
  2. Composer (si dépendances modifiées) : composer install --ignore-platform-req=ext-mbstring
  3. FileZilla : envoyer vers la racine FTP
    • config/ → racine (sans écraser config.local.php)
    • src/ → racine
    • templates/ → racine (requis pour la génération PDF)
    • vendor/ → racine
    • contenu de public/ → www/

Structure sur OVH

Racine FTP/
├── config/
├── src/
├── templates/
├── vendor/
├── storage/     (créé automatiquement par l'app)
└── www/
    ├── index.php
    ├── api/
    └── assets/

5. Endpoints API

Méthode URL Rôle
GET /api/pack.php?pack=onboarding-v1 Charge un pack de questions
POST /api/score.php Calcule le score et les résultats
POST /api/pdf.php Génère et renvoie le PDF
POST /api/email.php Capture email + stocke dans storage/outbox
POST /api/notify.php Inscription intérêt outil

6. Packs disponibles

pack_id Description
onboarding-v1 Onboarding collaborateur
validation-facture Validation de facture
process-generique Process universel

7. Documentation complémentaire

Fichier Contenu
docs/SECURITY.md Checklist sécurité, bonnes pratiques
docs/MODX_INTEGRATION.md Intégration dans MODX (templates, snippets, BD)