express-genix 1.1.4 → 2.0.0

package/LICENSE

@@ -0,0 +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
+SOFTWARE.

package/README.md

@@ -1,259 +1,204 @@
-# Express-Genix CLI
-
-express-genix is a production-grade CLI tool that generates Express.js applications with a robust, scalable foundation. It scaffolds projects with JWT authentication (including refresh tokens), MongoDB (with Mongoose) or PostgreSQL (with Sequelize), rate-limiting, security middleware (Helmet, CORS), custom logging, Swagger API documentation, Jest testing, ESLint (Airbnb style), Prettier formatting, and Docker support with database services. 
-
-**NEW**: Now includes a "No Database" option for APIs that don't require database persistence - perfect for microservices, proxy servers, or computational APIs.
-
-## Features
-
-- Generates Express apps with a clean structure (src/server.js, src/app.js, src/routes, etc.)
-- **Three database options**: MongoDB (Mongoose), PostgreSQL (Sequelize), or No Database
-- Includes JWT-based authentication with register, login, refresh tokens, and logout (database modes)
-- Provides security (Helmet, CORS, rate-limiting), logging (Morgan, custom logger), and Swagger UI
-- Sets up Jest/Supertest for testing, ESLint for code quality, and Prettier for formatting
-- **Automatic post-generation cleanup** - runs `eslint --fix` and Prettier formatting
-- **Zero linting errors out of the box** - generated code is production-ready immediately
-- Docker configuration with database services for easy deployment
-- User-friendly CLI with input validation and detailed output
-
-## Installation
-
-Install express-genix globally from npm to use it anywhere:
-
-```bash
-npm install -g express-genix
-```
-
-Alternatively, use it directly with npx without installation:
-
-```bash
-npx express-genix init
-```
-
-## Usage
-
-Run the CLI to generate a new Express project:
-
-```bash
-express-genix init
-```
-
-Or with npx:
-
-```bash
-npx express-genix init
-```
-
-### Prompts
-
-- **Project name**: Enter a name (letters, numbers, hyphens, underscores; default: my-express-app)
-- **Database**: Choose from:
-  - **MongoDB (with Mongoose)** - Full authentication system with JWT
-  - **PostgreSQL (with Sequelize)** - Full authentication system with JWT
-  - **No Database (API without database)** - Example CRUD API with in-memory storage
-
-The CLI creates a project directory, generates files, installs dependencies, and **automatically formats and lints the code**.
-
-Navigate to the generated project (e.g., `cd my-express-app`) and run:
-
-```bash
-npm run dev
-```
-
-Visit `http://localhost:3000/api-docs` for Swagger documentation or `http://localhost:3000/health` for health checks.
-
-### Generated Project Features
-
-**All Projects Include:**
-- Rate limiting, security middleware, logging
-- Swagger API documentation with OpenAPI 3.0
-- Jest testing with coverage
-- ESLint (Airbnb) + Prettier formatting
-- Docker support with clustering
-- Health checks and structured logging
-
-**Database Projects Include:**
-- **Authentication**: `/api/auth/register`, `/api/auth/login`, `/api/auth/refresh`, `/api/auth/logout`
-- **User Management**: `/api/users/profile` (GET, PUT, DELETE)
-- **Features**: JWT with refresh tokens, password hashing (bcrypt)
-
-**No-Database Projects Include:**
-- **Example API**: `/api/examples` (GET, POST, PUT, DELETE) with in-memory storage
-- **Perfect for**: Microservices, proxy servers, computational APIs
-
-### CLI Options
-
-```bash
-express-genix init --skip-cleanup    # Skip automatic formatting (for debugging)
-```
-
-## Project Structure
-
-### CLI Structure
-```
-express-genix/
-├── index.js                    # Main CLI entry point
-├── package.json                # CLI package configuration
-├── README.md                   # This documentation
-├── lib/
-│   ├── cleanup.js             # Post-generation cleanup functions
-│   ├── generator.js           # File generation logic
-│   └── utils.js               # Utility functions
-└── templates/
-    ├── core/                  # Core files (app.js, server.js, etc.)
-    ├── config/                # Configuration files
-    ├── controllers/           # Route handlers
-    ├── middleware/            # Custom middleware
-    ├── models/                # Database models
-    ├── routes/                # API routes
-    ├── services/              # Business logic
-    ├── utils/                 # Utilities
-    └── tests/                 # Test files
-```
-
-### Generated Express App Structure
-```
-├── src/
-│   ├── config/             # Database and Swagger configurations
-│   ├── controllers/        # Request handlers and business logic
-│   ├── middleware/         # Custom middleware (auth, validation, errors)
-│   ├── models/             # Database models (if using database)
-│   ├── routes/             # API route definitions
-│   ├── services/           # Business logic layer
-│   ├── utils/              # Utility functions and helpers
-│   ├── app.js              # Express app setup with middleware
-│   └── server.js           # Server entry point with clustering
-├── tests/                  # Jest tests for endpoints
-├── .env                    # Environment variables
-├── .eslintrc.json          # ESLint configuration
-├── .prettierrc             # Prettier configuration
-├── Dockerfile              # Docker configuration
-├── docker-compose.yml      # Docker services (app + database)
-└── package.json            # Dependencies and scripts
-```
-
-## Available Scripts (Generated Project)
-
-- `npm run dev` - Start development server with nodemon
-- `npm start` - Start production server with clustering
-- `npm test` - Run Jest tests with coverage
-- `npm run lint` - Run ESLint checks
-- `npm run lint:fix` - Fix ESLint issues automatically
-- `npm run format` - Format code with Prettier
-- `npm run format:check` - Check code formatting
-
-## Contributing
-
-To contribute to express-genix:
-
-1. **Fork and Clone**:
-   ```bash
-   git clone <your-fork-url>
-   cd express-genix
-   ```
-
-2. **Install Dependencies**:
-   ```bash
-   npm install
-   ```
-
-3. **Make Changes**:
-   - Update templates in `templates/` directory
-   - Modify generation logic in `lib/generator.js`
-   - Follow Airbnb JavaScript style
-   - Test changes locally: `node index.js init`
-   - Verify generated projects have zero linting errors
-
-4. **Submit a Pull Request**:
-   - Push changes and submit a PR with a clear description
-   - Include test results showing the generated project works correctly
-
-## Version History
-
-- **v1.1.0**: Added "No Database" option and template-based architecture with EJS
-- **v1.0.1**: Added automatic post-generation cleanup with Prettier and ESLint auto-fix
-- **v1.0.0**: Initial release with Express boilerplate generation
-
-## Publishing to npm
-
-To publish express-genix to npm, follow these steps from the CLI's root directory:
-
-### 1. Prepare the Project
-
-Ensure all template files are in place in the `templates/` directory structure.
-
-Verify `package.json` is configured correctly:
-
-```json
-{
-  "name": "express-genix",
-  "version": "1.1.0",
-  "description": "Production-grade CLI to generate Express apps with JWT, DB, rate-limiting, automatic formatting, and more",
-  "main": "index.js",
-  "bin": {
-    "express-genix": "./index.js"
-  },
-  "dependencies": {
-    "commander": "^12.1.0",
-    "inquirer": "^10.2.0",
-    "ejs": "^3.1.9"
-  }
-}
-```
-
-### 2. Test Locally
-
-Run the CLI to ensure it generates working, properly formatted projects for all three database options:
-
-```bash
-node index.js init
-```
-
-Test each option:
-- MongoDB with authentication
-- PostgreSQL with authentication  
-- No database with example API
-
-### 3. Publish
-
-Login to npm and publish:
-
-```bash
-npm login
-npm publish --access public
-```
-
-### 4. Verify
-
-Test the published package:
-
-```bash
-npx express-genix init
-# Should generate a project with zero linting errors
-```
-
-## Troubleshooting
-
-### Publishing Issues
-
-- **Name Conflict**: If `express-genix` is taken, use a scoped name like `@yourname/express-genix`
-- **Authentication Error**: Verify with `npm whoami`, re-login if needed
-- **Permission Issues**: Move project to a directory with full write access
-
-### Generated Project Issues
-
-- **Dependency Errors**: Run `npm cache clean --force && npm install`
-- **Database Connection**: Ensure MongoDB/PostgreSQL is running and connection strings are correct
-- **Linting Issues**: Run `npm run lint:fix && npm run format` to resolve formatting
-
-## License
-
-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.
+# 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.