Skip to content

TEMPLATE-README.md

Latest commit

 

History

History
83 lines (49 loc) · 2.05 KB

TEMPLATE-README.md

File metadata and controls

83 lines (49 loc) · 2.05 KB

[Nom de l'outil]

Favicon

Client-Side Privacy-First No Backend AGPL-3.0

[Description courte en une phrase]

Vue d'ensemble

[Description détaillée de l'outil, son objectif, et son public cible]

Fonctionnalités

  • [Fonctionnalité 1]
  • [Fonctionnalité 2]
  • [Fonctionnalité 3]

Utilisation

Prérequis

[Si nécessaire : navigateur, version, etc.]

Démarrage rapide

[Instructions simples pour utiliser l'outil]

Guide d'utilisation

[Instructions détaillées si nécessaire]

Architecture

Stack technique

  • Frontend : HTML5, CSS3, JavaScript vanilla (ES6+ modules)
  • Design System : [CHEMIN_VERS_SHARED]/shared/design-system/ (adapter selon profondeur)
  • Composants : [CHEMIN_VERS_SHARED]/shared/components/ (si utilisés)
  • Backend : [Aucun | Node.js http natif] (Option A ou B)
  • Dépendances : [Aucune | Lister les dépendances]
  • Build : Aucun

Structure des fichiers

tool-name/
├── index.html          # Page principale
├── app.js              # Logique principale (modules ES6)
├── modules/            # Modules optionnels
│   └── module.js
├── server.js           # Backend optionnel (Option B uniquement)
└── README.md           # Ce fichier

Déploiement

Voir docs/DEPLOYMENT.md pour le guide complet.

Variables d'environnement

[Si Option B : lister les variables nécessaires]

Confidentialité

[Description de la gestion des données : traitement côté client, pas de stockage serveur, etc.]

Contribution

Les contributions sont les bienvenues ! Voir docs/CONTRIBUTING.md.

Licence

AGPL-3.0 - Voir LICENSE

Auteur

Jason Rouet