npm - express-genix - Versions diffs - 1.1.3 → 1.1.5 - Mend

express-genix 1.1.3 → 1.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/LICENSE +21 -0
package/README.md +139 -189
package/lib/generator.js +1 -2
package/package.json +1 -1
package/templates/config/database.mongo.js.ejs +2 -4
package/templates/core/server.js.ejs +10 -5
package/templates/models/User.mongo.js.ejs +0 -3
/package/templates/services/{userService.mongo.js.ejs → userService.mongodb.js.ejs} +0 -0

package/LICENSE ADDED Viewed

@@ -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 CHANGED Viewed

@@ -1,259 +1,209 @@
-# Express-Genix CLI
+# Express-Genix
-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.
+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
-- 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
+**🚀 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
-## Installation
+## Quick Start
-Install express-genix globally from npm to use it anywhere:
+### Installation
 ```bash
 npm install -g express-genix
 ```
-Alternatively, use it directly with npx without installation:
+Or use directly with npx (no installation needed):
 ```bash
 npx express-genix init
 ```
-## Usage
-Run the CLI to generate a new Express project:
+### Create Your Project
 ```bash
 express-genix init
 ```
-Or with npx:
+Follow the prompts:
+1. **Project name** - Choose your project name (letters, numbers, hyphens, underscores)
+2. **Database** - Select MongoDB, PostgreSQL, or No Database
-```bash
-npx express-genix init
-```
+The CLI will:
+- Generate your project structure
+- Install all dependencies
+- Auto-format and lint the code
+- Set up Docker configuration
-### 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:
+### Run Your App
 ```bash
+cd your-project-name
 npm run dev
 ```
-Visit `http://localhost:3000/api-docs` for Swagger documentation or `http://localhost:3000/health` for health checks.
+Visit:
+- **API Documentation**: http://localhost:3000/api-docs
+- **Health Check**: http://localhost:3000/health
+## Generated API Endpoints
-### Generated Project Features
+### With Database (MongoDB/PostgreSQL)
-**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
+**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
-**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)
+**User Management** (Protected)
+- `GET /api/users/profile` - Get user profile
+- `PUT /api/users/profile` - Update user profile
+- `DELETE /api/users/profile` - Delete user account
-**No-Database Projects Include:**
-- **Example API**: `/api/examples` (GET, POST, PUT, DELETE) with in-memory storage
-- **Perfect for**: Microservices, proxy servers, computational APIs
+### Without Database
-### CLI Options
+**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
-express-genix init --skip-cleanup    # Skip automatic formatting (for debugging)
+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
-### 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
 ```
+your-project/
 ├── 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
+│   ├── 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
 ```
-## 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
+## Environment Variables
-## Contributing
+Create a `.env` file (generated automatically):
-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"
-  }
-}
+```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
 ```
-### 2. Test Locally
+## Docker Deployment
-Run the CLI to ensure it generates working, properly formatted projects for all three database options:
+The generated project includes Docker support:
 ```bash
-node index.js init
-```
+# Build and run with Docker Compose
+docker-compose up
-Test each option:
-- MongoDB with authentication
-- PostgreSQL with authentication
-- No database with example API
+# Or build manually
+docker build -t my-app .
+docker run -p 3000:3000 --env-file .env my-app
+```
-### 3. Publish
+## Troubleshooting
-Login to npm and publish:
+**Database Connection Issues**
+- Ensure MongoDB/PostgreSQL is running
+- Check connection string in `.env`
+- Verify database credentials
+**Dependency Errors**
 ```bash
-npm login
-npm publish --access public
+npm cache clean --force
+rm -rf node_modules package-lock.json
+npm install
 ```
-### 4. Verify
+**Port Already in Use**
+```bash
+# Change port in .env
+PORT=3001
+```
-Test the published package:
+## CLI Options
 ```bash
-npx express-genix init
-# Should generate a project with zero linting errors
+express-genix init --skip-cleanup    # Skip auto-formatting (for debugging)
 ```
-## Troubleshooting
-### Publishing Issues
+## Contributing
-- **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
+Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
-### Generated Project Issues
+## Support
-- **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
+- **Issues**: [GitHub Issues](https://github.com/yourusername/express-genix/issues)
+- **Documentation**: [Full Docs](https://github.com/yourusername/express-genix)
 ## 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:
+MIT © [Joshua Maeba Nyamasege](LICENSE)
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+## Changelog
-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.
+See [CHANGELOG.md](CHANGELOG.md) for version history and release notes.

package/lib/generator.js CHANGED Viewed

@@ -126,8 +126,7 @@ const generateFiles = async (config, projectDir) => {
   if (config.hasDatabase) {
     serviceFiles.push(
       { template: 'services/authService.js.ejs', output: 'src/services/authService.js' },
-      { template: `services/userService.${config.db === 'mongodb' ? 'mongodb' : 'postgresql'}.js.ejs`, output: 'src/services/userService.js' },
-    );
+      { template: `services/userService.${config.db === 'mongodb' ? 'mongodb' : 'postgres'}.js.ejs`, output: 'src/services/userService.js' },    );
   } else {
     serviceFiles.push(
       { template: 'services/exampleService.js.ejs', output: 'src/services/exampleService.js' },

package/package.json CHANGED Viewed

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

package/templates/config/database.mongo.js.ejs CHANGED Viewed

@@ -4,10 +4,8 @@ const mongoUri = process.env.MONGO_URI || 'mongodb://localhost:27017/<%= project
 const connect = async () => {
   try {
-    await mongoose.connect(mongoUri, {
-      useNewUrlParser: true,
-      useUnifiedTopology: true,
-    });
+    // Remove deprecated options - they're no longer needed in modern Mongoose
+    await mongoose.connect(mongoUri);
     console.log('MongoDB connected successfully');
   } catch (error) {
     console.error('MongoDB connection error:', error);

package/templates/core/server.js.ejs CHANGED Viewed

@@ -10,7 +10,8 @@ const startServer = async () => {<% if (hasDatabase) { %>
   if (cluster.isMaster) {
     const numCPUs = os.cpus().length;
-    console.log(`Master ${process.pid} is running`);
+    console.log(`🚀 Master ${process.pid} is running`);
+    console.log(`📊 Forking ${numCPUs} workers...`);
     // Fork workers
     for (let i = 0; i < numCPUs; i++) {
@@ -18,12 +19,16 @@ const startServer = async () => {<% if (hasDatabase) { %>
     }
     cluster.on('exit', (worker, code, signal) => {
-      console.log(`Worker ${worker.process.pid} died with code ${code} and signal ${signal}`);
+      console.log(`💥 Worker ${worker.process.pid} died with code ${code} and signal ${signal}`);
+      console.log('🔄 Starting a new worker...');
       cluster.fork();
     });
   } else {
     app.listen(port, () => {
-      console.log(`Worker ${process.pid} running on http://localhost:${port}`);
+      console.log(`🌟 Worker ${process.pid} running on http://localhost:${port}`);
+      console.log(`📚 API Documentation: http://localhost:${port}/api-docs`);
+      console.log(`❤️  Health Check: http://localhost:${port}/health`);
+      console.log(`🛠️  Environment: ${process.env.NODE_ENV || 'development'}`);
     });
   }
 };
@@ -32,13 +37,13 @@ startServer().catch(console.error);
 // Graceful Shutdown
 process.on('SIGTERM', async () => {
-  console.log('SIGTERM signal received: closing HTTP server');<% if (hasDatabase) { %>
+  console.log('🛑 SIGTERM signal received: closing HTTP server');<% if (hasDatabase) { %>
   await db.disconnect();<% } %>
   process.exit(0);
 });
 process.on('SIGINT', async () => {
-  console.log('SIGINT signal received: closing HTTP server');<% if (hasDatabase) { %>
+  console.log('🛑 SIGINT signal received: closing HTTP server');<% if (hasDatabase) { %>
   await db.disconnect();<% } %>
   process.exit(0);
 });

package/templates/models/User.mongo.js.ejs CHANGED Viewed

@@ -26,8 +26,5 @@ const userSchema = new mongoose.Schema({
   timestamps: true,
 });
-// Index for better query performance
-userSchema.index({ email: 1 });
-userSchema.index({ username: 1 });
 module.exports = mongoose.model('User', userSchema);

/package/templates/services/{userService.mongo.js.ejs → userService.mongodb.js.ejs} RENAMED Viewed

File without changes