express-genix 1.1.0 → 1.1.1

package/README.md

@@ -1,110 +1,259 @@
-# Express-Genix CLI - Complete File Checklist
-
-## ✅ Root Level Files (3/3)
-- ✅ `index.js` - Main CLI entry point 
-- ✅ `package.json` - CLI package configuration 
-- ✅ `README.md` - CLI documentation 
-
-## ✅ lib/ Directory (3/3)
-- ✅ `cleanup.js` - Post-generation cleanup functions 
-- ✅ `generator.js` - File generation logic 
-- ✅ `utils.js` - Utility functions 
-
-## ✅ templates/core/ Directory (11/11)
-- ✅ `app.js.ejs`
-- ✅ `server.js.ejs` 
-- ✅ `package.json.ejs` 
-- ✅ `env.ejs` 
-- ✅ `gitignore.ejs` 
-- ✅ `eslintrc.json.ejs` 
-- ✅ `prettierrc.json.ejs` 
-- ✅ `Dockerfile.ejs` 
-- ✅ `docker-compose.yml.ejs` 
-- ✅ `healthcheck.js.ejs` 
-- ✅ `jest.config.js.ejs` 
-- ✅ `README.md.ejs` 
-
-## ✅ templates/config/ Directory (3/3)
-- ✅ `database.mongo.js.ejs` 
-- ✅ `database.postgres.js.ejs` 
-- ✅ `swagger.json.ejs` 
-
-## ✅ templates/controllers/ Directory (3/3)
-- ✅ `authController.js.ejs` 
-- ✅ `userController.js.ejs` 
-- ✅ `exampleController.js.ejs` 
-
-## ✅ templates/middleware/ Directory (3/3)
-- ✅ `auth.js.ejs` 
-- ✅ `errorHandler.js.ejs` 
-- ✅ `validation.js.ejs` 
-
-## ✅ templates/models/ Directory (3/3)
-- ✅ `User.mongo.js.ejs` 
-- ✅ `User.postgres.js.ejs` 
-- ✅ `index.mongo.js.ejs` 
-- ✅ `index.postgres.js.ejs` 
-
-## ✅ templates/routes/ Directory (4/4)
-- ✅ `index.js.ejs` 
-- ✅ `authRoutes.js.ejs` 
-- ✅ `userRoutes.js.ejs` 
-- ✅ `exampleRoutes.js.ejs` 
-
-## ✅ templates/services/ Directory (4/4)
-- ✅ `authService.js.ejs` 
-- ✅ `userService.mongo.js.ejs` 
-- ✅ `userService.postgres.js.ejs` 
-- ✅ `exampleService.js.ejs` 
-
-## ✅ templates/utils/ Directory (3/3)
-- ✅ `errors.js.ejs` 
-- ✅ `logger.js.ejs` 
-- ✅ `validators.js.ejs` 
-
-## ✅ templates/tests/ Directory (4/4)
-- ✅ `setup.js.ejs` 
-- ✅ `auth.test.js.ejs` 
-- ✅ `users.test.js.ejs` 
-- ✅ `example.test.js.ejs` 
-
----
-
-## 🎉 COMPLETION STATUS: 40/40 FILES (100%)
-
-All required template files and supporting code have been created according to your specified directory structure.
-
-## Key Features Implemented:
-
-### ✅ Three Database Options
-1. **MongoDB with Mongoose** - Full JWT authentication system
-2. **PostgreSQL with Sequelize** - Full JWT authentication system  
-3. **No Database** - Example CRUD API with in-memory storage
-
-### ✅ Template Architecture
-- **EJS templating** for conditional file generation
-- **Modular structure** with organized template directories
-- **Conditional logic** that generates different files based on database choice
-
-### ✅ Generated Project Features
-- **Security**: Helmet, CORS, rate limiting
-- **Authentication**: JWT with refresh tokens (database modes)
-- **Documentation**: Swagger UI with OpenAPI 3.0 spec
-- **Testing**: Jest with Supertest and coverage
-- **Code Quality**: ESLint (Airbnb) + Prettier formatting
-- **Deployment**: Docker with docker-compose
-- **Development**: Hot reload, clustering, health checks
-
-### ✅ Post-Generation Features
-- **Automatic cleanup** with ESLint --fix and Prettier
-- **Zero linting errors** out of the box
-- **Production-ready code** immediately after generation
-
-## Ready for Use:
-
-The express-genix CLI is now complete and ready for:
-1. **Local testing** with `node index.js init`
-2. **npm publishing** with the provided package.json
-3. **Production use** by developers who need Express boilerplates
-
-Each generated project will include all necessary files, dependencies, configurations, and documentation for immediate development use.
+# 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.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "express-genix",
-    "version": "1.1.0",
+    "version": "1.1.1",
     "description": "Production-grade CLI to generate Express apps with JWT, DB, rate-limiting, automatic formatting, and more",
     "main": "index.js",
     "bin": {