express-route-gen-cli
v1.0.2
Published
Générateur automatique de routes Express avec Sequelize, MySQL et Swagger
Maintainers
Readme
Express Route Gen CLI
Générateur automatique de routes Express avec Sequelize, MySQL et Swagger en une seule commande !
✨ Fonctionnalités
- ✅ Routes Express complètes avec CRUD
- ✅ Modèles Sequelize automatiques
- ✅ Migrations MySQL
- ✅ Documentation Swagger intégrée
- ✅ Contrôleurs avec gestion d'erreurs
📦 Installation
npm install -g express-route-gen-cli🚀 Quick Start
# 1. Créer un projet
mkdir my-api && cd my-api
npm init -y
# 2. Installer les dépendances
npm install express sequelize mysql2 swagger-jsdoc swagger-ui-express
# 3. Initialiser la structure
express-gen init
# 4. Configurer MySQL dans src/config/config.json
# 5. Générer une route
express-gen route products
# 6. Créer la table
npx sequelize-cli db:migrate
# 7. Démarrer
npm startOuvrez http://localhost:3000/api-docs pour voir la documentation Swagger ! 📚
📖 Commandes
express-gen init- Initialise le projetexpress-gen route <nom>- Génère une route complèteexpress-gen --version- Affiche la versionexpress-gen --help- Affiche l'aide
🎯 Ce qui est généré
Chaque commande express-gen route products crée automatiquement :
src/modules/v1/products/
├── products.model.js (Modèle Sequelize)
├── products.controller.js (CRUD complet)
└── products.routes.js (Routes + Swagger)
src/migrations/
└── [timestamp]-create-products.js (Migration MySQL)Et met à jour automatiquement src/routes/v1/index.js !
📝 Exemple
express-gen route users
express-gen route products
express-gen route orders
npx sequelize-cli db:migrate
npm startVous obtenez instantanément 15 endpoints (5 par module) avec documentation complète ! 🎉
🔧 Configuration
Après express-gen init, modifiez :
src/config/config.json
{
"development": {
"username": "root",
"password": "votre_mot_de_passe",
"database": "votre_database",
"host": "127.0.0.1",
"dialect": "mysql"
}
}📚 Stack technique
- Express.js - Framework web
- Sequelize - ORM MySQL
- Swagger - Documentation API
- MySQL - Base de données
📄 Licence
MIT
👨💻 Auteur
Créé avec ❤️ par [Ton Nom]
🤝 Contribution
Les contributions sont les bienvenues ! N'hésitez pas à ouvrir une issue ou un pull request.
