Skip to content

ShHaWkK/TemplateAPI

Repository files navigation

  |__   __|                     | |       | |            /\    |  __ \|_   _|
     | |  ___  _ __ ___   _ __  | |  __ _ | |_  ___     /  \   | |__) | | |  
     | | / _ \| '_ ` _ \ | '_ \ | | / _` || __|/ _ \   / /\ \  |  ___/  | |  
     | ||  __/| | | | | || |_) || || (_| || |_|  __/  / ____ \ | |     _| |_ 
     |_| \___||_| |_| |_|| .__/ |_| \__,_| \__|\___| /_/    \_\|_|    |_____|
                         | |                                                 
                         |_|                                

🚀 Utilisation

# installer les dépendances du générateur
npm install

# lancer le générateur (interactif)
npm run dev
# ou après build
npm run build
node dist/cli/index.js

Exécution directe

# générer une API TypeScript avec authentification et gestion utilisateurs
node dist/cli/index.js my-api \
  --language typescript \
  --features auth,userCrud,clientPortal,adminPortal \
  --package-manager npm

🧭 Options disponibles

Option Description
--language typescript (par défaut) ou javascript.
--features Modules à inclure séparés par des virgules : auth, userCrud, clientPortal, adminPortal. Les dépendances sont résolues automatiquement (ex: userCrud active auth).
--package-manager npm, pnpm ou yarn. Détermine les scripts affichés dans le README généré.
--dry-run Simule la génération sans écrire de fichiers.

📦 Sortie générée

Le projet créé contient :

  • un dossier src/ structuré par couches hexagonales,
  • des tests (tests/) et utilitaires prêts à l'emploi,
  • la documentation (docs/insomnia, src/interface/http/docs/openapi),
  • des fichiers de configuration (ESLint, Prettier, Jest, Docker).

La version JavaScript est générée à partir des mêmes sources TypeScript et convertie automatiquement.

🛠 Développement

Script Description
npm run dev Lance le CLI en TypeScript (ts-node).
npm run build Compile le CLI vers dist/.
npm test Vérifie la compilation TypeScript sans émettre de fichiers.

📄 Licence

Ce projet est sous licence MIT.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published