express-genix 1.1.5 → 2.0.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Joshua Maeba Nyamasege
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2025 Joshua Maeba Nyamasege
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -1,209 +1,204 @@
-# Express-Genix
-
-A production-grade CLI tool that generates Express.js applications with a robust, scalable foundation. Get a complete REST API up and running in seconds with authentication, database integration, security, testing, and Docker support.
-
-## Features
-
-**🚀 Three Setup Options**
-- **MongoDB** - Full-stack with Mongoose ORM and JWT authentication
-- **PostgreSQL** - Enterprise-ready with Sequelize ORM and JWT authentication  
-- **No Database** - Perfect for microservices, proxy servers, or computational APIs
-
-**🔐 Security & Authentication**
-- JWT authentication with refresh tokens (database modes)
-- Helmet security headers
-- CORS configuration
-- Rate limiting out of the box
-- Password hashing with bcrypt
-
-**📚 Developer Experience**
-- Swagger/OpenAPI documentation
-- Jest testing with Supertest
-- ESLint (Airbnb) + Prettier pre-configured
-- Auto-formatted code (zero linting errors)
-- Structured logging
-- Health check endpoints
-
-**🐳 Production Ready**
-- Docker & Docker Compose included
-- Clustering support for performance
-- Graceful shutdown handling
-- Environment-based configuration
-
-## Quick Start
-
-### Installation
-
-```bash
-npm install -g express-genix
-```
-
-Or use directly with npx (no installation needed):
-
-```bash
-npx express-genix init
-```
-
-### Create Your Project
-
-```bash
-express-genix init
-```
-
-Follow the prompts:
-1. **Project name** - Choose your project name (letters, numbers, hyphens, underscores)
-2. **Database** - Select MongoDB, PostgreSQL, or No Database
-
-The CLI will:
-- Generate your project structure
-- Install all dependencies
-- Auto-format and lint the code
-- Set up Docker configuration
-
-### Run Your App
-
-```bash
-cd your-project-name
-npm run dev
-```
-
-Visit:
-- **API Documentation**: http://localhost:3000/api-docs
-- **Health Check**: http://localhost:3000/health
-
-## Generated API Endpoints
-
-### With Database (MongoDB/PostgreSQL)
-
-**Authentication**
-- `POST /api/auth/register` - Register new user
-- `POST /api/auth/login` - User login
-- `POST /api/auth/refresh` - Refresh access token
-- `POST /api/auth/logout` - User logout
-
-**User Management** (Protected)
-- `GET /api/users/profile` - Get user profile
-- `PUT /api/users/profile` - Update user profile
-- `DELETE /api/users/profile` - Delete user account
-
-### Without Database
-
-**Example API** (In-memory CRUD)
-- `GET /api/examples` - List all examples (with pagination)
-- `GET /api/examples/:id` - Get example by ID
-- `POST /api/examples` - Create new example
-- `PUT /api/examples/:id` - Update example
-- `DELETE /api/examples/:id` - Delete example
-
-## Available Scripts
-
-```bash
-npm run dev              # Development server with hot reload
-npm start                # Production server with clustering
-npm test                 # Run tests with coverage
-npm run lint             # Check code quality
-npm run lint:fix         # Auto-fix linting issues
-npm run format           # Format code with Prettier
-npm run format:check     # Verify code formatting
-```
-
-## Project Structure
-
-```
-your-project/
-├── src/
-│   ├── config/          # Database and Swagger config
-│   ├── controllers/     # Request handlers
-│   ├── middleware/      # Auth, validation, errors
-│   ├── models/          # Database models (if enabled)
-│   ├── routes/          # API routes
-│   ├── services/        # Business logic
-│   ├── utils/           # Helper functions
-│   ├── app.js           # Express setup
-│   └── server.js        # Server entry point
-├── tests/               # Test suites
-├── .env                 # Environment variables
-├── Dockerfile           # Container config
-└── docker-compose.yml   # Multi-container setup
-```
-
-## Environment Variables
-
-Create a `.env` file (generated automatically):
-
-```bash
-# Server
-NODE_ENV=development
-PORT=3000
-
-# Database (if using MongoDB/PostgreSQL)
-MONGO_URI=mongodb://localhost:27017/myapp
-# or
-DATABASE_URL=postgresql://user:password@localhost:5432/myapp
-
-# JWT (if using database)
-JWT_SECRET=your-secret-key
-JWT_REFRESH_SECRET=your-refresh-secret
-JWT_EXPIRE=15m
-JWT_REFRESH_EXPIRE=7d
-
-# Rate Limiting
-RATE_LIMIT_WINDOW_MS=900000
-RATE_LIMIT_MAX=100
-```
-
-## Docker Deployment
-
-The generated project includes Docker support:
-
-```bash
-# Build and run with Docker Compose
-docker-compose up
-
-# Or build manually
-docker build -t my-app .
-docker run -p 3000:3000 --env-file .env my-app
-```
-
-## Troubleshooting
-
-**Database Connection Issues**
-- Ensure MongoDB/PostgreSQL is running
-- Check connection string in `.env`
-- Verify database credentials
-
-**Dependency Errors**
-```bash
-npm cache clean --force
-rm -rf node_modules package-lock.json
-npm install
-```
-
-**Port Already in Use**
-```bash
-# Change port in .env
-PORT=3001
-```
-
-## CLI Options
-
-```bash
-express-genix init --skip-cleanup    # Skip auto-formatting (for debugging)
-```
-
-## Contributing
-
-Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
-
-## Support
-
-- **Issues**: [GitHub Issues](https://github.com/yourusername/express-genix/issues)
-- **Documentation**: [Full Docs](https://github.com/yourusername/express-genix)
-
-## License
-
-MIT © [Joshua Maeba Nyamasege](LICENSE)
-
-## Changelog
-
-See [CHANGELOG.md](CHANGELOG.md) for version history and release notes.
+# Express-Genix
+
+A production-grade CLI tool that generates Express.js applications with best-in-class defaults. Scaffold a complete REST API in seconds — with TypeScript, authentication, Prisma/Mongoose/Sequelize, Docker, CI/CD, and more.
+
+[![npm version](https://img.shields.io/npm/v/express-genix.svg)](https://www.npmjs.com/package/express-genix)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Node.js](https://img.shields.io/badge/node-%3E%3D18-brightgreen.svg)](https://nodejs.org)
+
+## Features
+
+**Languages & ORMs**
+- JavaScript or TypeScript
+- MongoDB (Mongoose), PostgreSQL (Sequelize), PostgreSQL (Prisma), or no database
+- Sequelize CLI migrations for PostgreSQL, Prisma migrations ready out of the box
+
+**Security & Auth**
+- JWT access + refresh tokens with token blacklist logout
+- Optional Redis-backed blacklist for production multi-instance deployments
+- bcrypt password hashing, input sanitization (`validator`)
+- Helmet, CORS, environment validation on startup
+- Auto-generated cryptographically secure JWT secrets
+
+**API & Documentation**
+- Swagger UI + swagger-jsdoc annotation-based docs
+- Consistent `{ success, data, meta }` response envelope
+- Paginated list endpoints
+- Request ID / correlation tracking
+
+**Developer Experience**
+- Interactive prompts — pick language, database, features via checkbox
+- Winston or Pino logger (you choose)
+- ESLint (Airbnb) + Prettier pre-configured
+- Jest + Supertest with coverage
+- Rate limiting with configurable window/max
+
+**Production Ready**
+- Docker & Docker Compose (multi-stage, non-root user)
+- GitHub Actions CI/CD (matrix testing, DB services)
+- Node.js clustering with graceful shutdown
+- Rollback on generation failure
+- Git init + initial commit
+
+**Post-Init**
+- `express-genix add <feature>` — bolt on auth, websocket, docker, cicd, or prisma to an existing project
+
+## Quick Start
+
+### Install globally
+
+```bash
+npm install -g express-genix
+```
+
+Or use with npx:
+
+```bash
+npx express-genix init
+```
+
+### Create a project
+
+```bash
+express-genix init
+```
+
+You'll be prompted for:
+
+1. **Project name**
+2. **Language** — JavaScript or TypeScript
+3. **Database** — MongoDB, PostgreSQL (Sequelize), PostgreSQL (Prisma), or None
+4. **Features** — Auth, Rate Limiting, Swagger, Redis Token Blacklist, Docker, CI/CD, WebSocket, Request ID
+5. **Logger** — Winston or Pino
+
+The CLI generates your project, installs dependencies, formats code, and creates an initial git commit.
+
+### Run it
+
+```bash
+cd my-express-app
+npm run dev
+```
+
+- **API**: http://localhost:3000/api
+- **Swagger Docs**: http://localhost:3000/api-docs
+- **Health Check**: http://localhost:3000/health
+
+## Add features to an existing project
+
+```bash
+cd my-express-app
+express-genix add docker      # Adds Dockerfile, docker-compose.yml, .dockerignore
+express-genix add cicd        # Adds GitHub Actions CI workflow
+express-genix add auth        # Adds JWT auth, controllers, routes, middleware
+express-genix add websocket   # Adds Socket.io setup
+express-genix add prisma      # Adds Prisma schema, client config, migrations
+```
+
+## Generated Project Structure
+
+```
+my-express-app/
+├── src/
+│   ├── config/          # Database, Swagger, WebSocket configuration
+│   ├── controllers/     # Route handlers
+│   ├── middleware/       # Auth, validation, error handling, request ID
+│   ├── models/          # Database models (Mongoose/Sequelize)
+│   ├── routes/          # API route definitions with Swagger annotations
+│   ├── services/        # Business logic layer
+│   ├── utils/           # Logger, errors, response helpers, validators
+│   ├── app.js|ts        # Express app setup
+│   └── server.js|ts     # Server + clustering + WebSocket
+├── tests/               # Jest + Supertest suites
+├── prisma/              # Prisma schema (if selected)
+├── migrations/          # Sequelize migrations (if PostgreSQL + Sequelize)
+├── seeders/             # Sequelize seeders (if PostgreSQL + Sequelize)
+├── .github/workflows/   # CI/CD pipeline (if selected)
+├── .env                 # Auto-generated environment config
+├── .env.example         # Template for team sharing
+├── Dockerfile           # Multi-stage Docker build (if selected)
+├── docker-compose.yml   # Full stack compose (if selected)
+└── package.json
+```
+
+## API Endpoints (with database + auth)
+
+### Authentication
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| POST | `/api/auth/register` | Register a new user |
+| POST | `/api/auth/login` | Login (returns access + refresh tokens) |
+| POST | `/api/auth/refresh` | Refresh access token |
+| POST | `/api/auth/logout` | Logout (blacklists token) |
+
+### Users (protected)
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| GET | `/api/users/profile` | Get current user |
+| PUT | `/api/users/profile` | Update profile |
+| DELETE | `/api/users/profile` | Delete account |
+
+### Health
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| GET | `/health` | Health check with uptime + DB status |
+
+## Available Scripts
+
+```bash
+npm run dev          # Development server with auto-reload
+npm start            # Production server with clustering
+npm test             # Run tests with coverage
+npm run lint         # Check ESLint
+npm run lint:fix     # Auto-fix ESLint issues
+npm run format       # Format with Prettier
+npm run format:check # Verify formatting
+npm run build        # Compile TypeScript (TS projects only)
+npm run db:migrate   # Run Sequelize migrations (PostgreSQL)
+npm run db:migrate:undo  # Undo last migration
+npm run prisma:migrate   # Run Prisma migrations
+npm run prisma:studio    # Open Prisma Studio
+```
+
+## CLI Options
+
+```bash
+express-genix init --skip-install   # Skip npm install (useful for CI)
+express-genix init --skip-cleanup   # Skip auto-formatting (for debugging)
+express-genix add <feature>         # Add feature to existing project
+```
+
+## Environment Variables
+
+Generated `.env` includes auto-generated JWT secrets:
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `NODE_ENV` | Environment | `development` |
+| `PORT` | Server port | `3000` |
+| `CORS_ORIGIN` | Allowed origins | `*` |
+| `JWT_SECRET` | Access token secret (auto-generated) | — |
+| `JWT_REFRESH_SECRET` | Refresh token secret (auto-generated) | — |
+| `MONGO_URI` / `DATABASE_URL` | Database connection string | — |
+| `REDIS_URL` | Redis URL (when Redis blacklist enabled) | `redis://localhost:6379` |
+| `RATE_LIMIT_WINDOW_MS` | Rate limit window (ms) | `900000` |
+| `RATE_LIMIT_MAX` | Max requests per window | `100` |
+| `LOG_LEVEL` | Logging level | `info` |
+
+## Docker
+
+```bash
+docker-compose up --build
+```
+
+## Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details.
+
+## License
+
+MIT © [Joshua Maeba Nyamasege](LICENSE)
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for version history.