Guide utilisateur

Documentation Badge Studio

Créez, personnalisez et générez des badges nominatifs à partir d’un template et d’un fichier Excel — en ligne, avec les mêmes capacités que l’application bureau.

1. Démarrage rapide

  1. Lancez l’API via saas/Lancer API.bat.
  2. Ouvrez l’éditeur sur http://127.0.0.1:8000.
  3. Importez un fichier Excel, des photos (fichiers ou dossier) et un template image — ou créez un fond uni coloré.
  4. Ajoutez des éléments (texte, photo, QR, logo, cadre), positionnez-les, puis cliquez sur Générer les badges.

2. Éditeur de badges

  • Éléments — ajoutez Texte, Photo, QR, Logo ou Cadre ; réordonnez, dupliquez ou supprimez.
  • Aperçu — prévisualisez chaque enregistrement (Précédent / Suivant).
  • Propriétés — police, couleur, colonne Excel, opacité, etc.
  • Google Fonts — bouton GF dans les propriétés texte pour installer une police.
  • Photos URL — téléchargez les photos depuis une colonne d’URL.
  • Taille template — dans Propriétés : L×H en px / mm / cm ; le plan de travail s’adapte à l’application.
  • Formats — PNG, JPEG, PDF, TIFF (+ PDF unique).
  • Feuille — Badge seul, ou grille automatique sur A4 / A3 selon la taille du template (marges 8 mm, écart 3 mm).
  • Projet — importez un fichier .json issu de l’app bureau.

3. Comptes & plans

SituationLimite
Sans compte10 badges par génération · pas de sauvegarde cloud
Plan Gratuit50 badges par génération · pas de sauvegarde cloud
ProIllimité · projets cloud (50) · historique 30 jours
BusinessIllimité · projets cloud (200) · historique 90 jours

Inscription e-mail / mot de passe ou Google OAuth (si configuré). Sur Pro/Business : Nouveau projet (nommer avant de travailler), Renommer, Enregistrer et Mes projets (réouverture + historique des générations). Consultez la page Tarifs pour souscrire.

4. Paiement

  • Mode démo — active le plan immédiatement sans carte (BILLING_DEMO_MODE=true).
  • Stripe — Checkout sécurisé + webhook /api/billing/webhook.

Plans : Gratuit (0 €), Pro (29 €/mois), Business (79 €/mois) — montants configurables.

5. Backoffice administrateur

Accessible sur /admin (compte admin uniquement).

  • KPI : inscriptions, badges générés, revenus, MRR estimé
  • Gestion des utilisateurs (plan, rôle admin)
  • Historique des générations
  • Saisie / suivi des revenus

Identifiants par défaut (à changer) : admin@badgestudio.local / admin123.

6. Stockage des données

Fichiers sous saas/storage/ ; comptes et analytics en MySQL :

  • MySQL — comptes, plans, jobs, revenus (DATABASE_BACKEND=mysql)
  • sessions/ — projets d’édition en cours
  • tasks/ — générations et fichiers ZIP résultats

7. Configuration

Variables dans saas/.env (voir .env.example) :

  • DATABASE_BACKEND / MYSQL_* — MySQL (ou sqlite)
  • EAGER_MODE=true — génération sans Redis (dev)
  • GOOGLE_CLIENT_* — OAuth Google
  • STRIPE_* — paiements
  • ADMIN_EMAIL / ADMIN_PASSWORD — bootstrap admin
  • FREE_BADGE_LIMIT, FREE_PLAN_BADGE_LIMIT, prix des plans

8. API technique

Documentation interactive OpenAPI (Swagger) : /docs

Principaux préfixes :

  • /api/auth/* — inscription, login, Google, quota
  • /api/session/* — éditeur
  • /api/billing/* — checkout & webhook
  • /api/admin/* — backoffice
  • /api/plans — catalogue des tarifs