create-jerry 1.0.0 → 2.0.0

package/README.md

@@ -1,81 +1,251 @@
-# JERRIT: Backend Project Scaffolding Tool
+# 🚀 create-jerry (JerrIt CLI)
+
+> A lightning-fast CLI tool to scaffold production-ready Express backend projects with MongoDB or MySQL, plugin-based architecture, and optional AI module support.
+
+[![npm version](https://img.shields.io/npm/v/create-jerry.svg)](https://www.npmjs.com/package/create-jerry)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+---
+
+## ✨ Overview
+
+**create-jerry** is a backend scaffolding CLI inspired by tools like Vite and Create React App.
+
+It generates a structured Express.js backend with:
+
+- MongoDB OR MySQL support
+- JavaScript OR TypeScript support
+- Optional AI module (OpenAI integration)
+- Plugin-based architecture (extensible design)
+- Clean modular folder structure
+
 ---
 
-## Problem Statement:
-A Project Scaffolding Framework similar to Vite.js and Next.js that aims to provide a ready-to-code boilerplate for working with MongoDB or MySQL databases through express.js server. The Project aims to minimize the setup time for building a MERN or SERN app, enhancing productivity and efficiency for developers.
+## ⚡ Features
+
+- 🎯 Interactive CLI prompts (Inquirer-based)
+- 🧠 Optional AI module (OpenAI integration)
+- 🗄️ Database selection (MongoDB / MySQL)
+- 🧾 JavaScript & TypeScript support
+- 🔌 Plugin-based architecture system
+- 📁 Production-ready folder structure
+- ⚙️ Auto dependency injection in package.json
+- 🚀 Fully working Express server setup
 
 ---
 
+## 🚀 Quick Start
 
-## Project Structure:
-``` 
-XeoBuilds/
- |_ Templates/
- |  |_ db-mongo.js
- |  |_ db-sql.js
- |  |_ express.js
- |
- |_ .gitignore
- |_ fileCreator.js
- |_ folderCreator.js
- |_ installer.js
- |_ index.js
- |_ package.json
- |_ package-lock.json
- |_ README.md
+```bash
+npx create-jerry
 ```
+
+Then follow prompts:
+
+1. Project name
+2. Database (MongoDB / MySQL)
+3. Language (JavaScript / TypeScript)
+4. AI module (Yes / No)
+
 ---
 
+## 📦 What Gets Generated
+
+### Project Structure
+
+```
+your-project/
+├── src/
+│   ├── config/
+│   │   ├── db.js / db.ts
+│   │   └── index.js
+│   │
+│   ├── modules/
+│   │   ├── user/
+│   │   └── ai/ (optional)
+│   │
+│   ├── routes/
+│   │   └── index.js
+│   │
+│   ├── middlewares/
+│   │   └── error.middleware.js
+│   │
+│   ├── utils/
+│   │   └── asyncHandler.js
+│   │
+│   ├── app.js
+│   └── server.js
+│
+├── .env
+├── package.json
+└── tsconfig.json (if TypeScript)
+```
 
-## Libraries used to build:
-- inquirer
-- chalk 
-- chalkAnimation
-- execSync
-- nanospinner
-- fs module
-<!-- fs/promises module -->
 ---
 
+## 🧠 Architecture
+
+This CLI uses a **plugin-based generator system**:
+
+### Supported Plugins
+
+- 🟢 MongoDB Plugin
+- 🟡 MySQL Plugin
+- 🤖 AI Plugin (OpenAI)
+
+### Each Plugin Handles:
+
+- Module generation (if required)
+- Dependency injection
+- Route injection
+- Setup logic execution
 
-## Packages/Libraries for Backend:
-- express
-- cors
-- mongoose
-- mysql2
-- dotenv
-- router
 ---
 
+## 🔌 Example CLI Flow
 
-## Backend Generated:
+```bash
+✔ Project name? my-app
+✔ Select Database MongoDB
+✔ Select Language Typescript
+✔ Add AI module? Yes
 ```
-project-name/
- |_ Models/
- |  |_ db.js
- |
- |_ Controller/
- |  |_ index.js
- |
- |_ Middleware/
- |  |_ handler.js
- |
- |_ Config/
- |  |_ .env
- |
- |_ app.js
- |_ package.json
+
+### Output:
+
+- MongoDB configured project
+- AI module added (optional)
+- Routes auto-injected
+- Dependencies installed dynamically
+
+---
+
+## 🧰 Available Scripts (Generated Project)
+
+```bash
+npm run dev      # Development mode
+npm start        # Production mode
+npm run build    # TypeScript build (if TS)
 ```
+
 ---
 
+## 🧠 AI Module (Optional)
+
+When enabled:
+
+- `/ai/chat` endpoint is created
+- OpenAI SDK installed
+- Controller → Service → Provider architecture
+- GPT-powered backend endpoint ready to use
 
-## Demo Video:
-Video Link: https://drive.google.com/file/d/1o_9_5RMI21Inew4knCqXlCmeArhAG3xD/view?usp=sharing  
-<!-- ![]() -->
 ---
 
+## 🗄️ Database Support
 
+### MongoDB
 
-<!-- ## Low Level Daigram   ## Challenges  -->
-# Thank You, Don't forget to add a ⭐
+- Mongoose integration
+- Predefined User model + CRUD
+- Auto connection setup
+
+### MySQL
+
+- mysql2 connection pool
+- Prebuilt SQL queries
+- Ready-to-use CRUD layer
+
+---
+
+## 🔌 Plugin System
+
+Plugins follow this structure:
+
+```js
+{
+  name: "plugin-name",
+  setup(),
+  inject,
+  dependencies
+}
+```
+
+### Benefits:
+
+- Extensible architecture
+- Clean separation of concerns
+- Easy future expansion (auth, redis, payments, etc.)
+
+---
+
+## 📚 Tech Stack
+
+- Node.js
+- Express.js
+- Inquirer.js
+- Chalk
+- Nanospinner
+- OpenAI SDK (optional)
+- Mongoose / MySQL2
+
+---
+
+## 🎯 Why create-jerry?
 
+Because backend setup is repetitive:
+
+- Folder structure setup ❌
+- Database configuration ❌
+- Boilerplate code ❌
+
+Now:
+
+```bash
+npx create-jerry
+```
+
+Done in seconds ⚡
+
+---
+
+## 🛠️ Future Plans
+- 🟦 Typescript Migration
+- 🔐 Authentication plugin (JWT / OAuth)
+- ⚡ Redis caching plugin
+- 📦 Docker support
+- 🧪 Testing setup (Jest)
+- ☁️ Deployment presets
+
+---
+
+## 👨‍💻 Author
+
+**Tanmay Khanna**
+
+- GitHub: [@TomLucasakaTGeek](https://github.com/TomLucasakaTGeek)
+- Project: JerrIt CLI
+
+---
+
+## ⭐ Support
+
+If this helped you:
+
+- ⭐ Star the repo
+- 🔁 Share with developers
+- 🧩 Contribute plugins
+
+---
+
+## 📄 License
+
+MIT License
+
+---
+
+**Built with ❤️ to make backend development faster and easier**
+
+
+
+<!-- ## Low Level Daigram   ## Challenges  -->
+<!-- ======= -->

package/Templates/base/js/app.js

@@ -0,0 +1,19 @@
+import express from 'express';
+import cors from 'cors';
+import routes from './routes/index.js';
+import { errorHandler } from './middlewares/error.middleware.js';
+
+const app = express();
+
+app.use(cors());
+app.use(express.json());
+
+app.use('/api', routes);
+
+app.get('/health', (_, res) => {
+  res.json({ status: 'OK' });
+});
+
+app.use(errorHandler);
+
+export default app;

package/Templates/base/js/config/index.js

@@ -0,0 +1,18 @@
+import dotenv from 'dotenv';
+
+dotenv.config();
+
+export const config = {
+  port: process.env.PORT || 3000,
+
+  // MongoDB
+  mongoUri: process.env.MONGO_URI,
+
+  // MySQL
+  mysql: {
+    host: process.env.MYSQL_HOST,
+    user: process.env.MYSQL_USER,
+    password: process.env.MYSQL_PASSWORD,
+    database: process.env.MYSQL_DATABASE
+  }
+};

package/Templates/base/js/middlewares/error.middleware.js

@@ -0,0 +1,8 @@
+export const errorHandler = (err, _req, res, _next) => {
+  console.error(err);
+
+  res.status(err.status || 500).json({
+    success: false,
+    message: err.message || 'Internal Server Error',
+  });
+};

package/Templates/base/js/routes/index.js

@@ -0,0 +1,12 @@
+import { Router } from 'express';
+import userRoutes from '../modules/user/user.routes.js';
+
+// [IMPORT_ROUTES]
+
+const router = Router();
+
+router.use('/users', userRoutes);
+
+// [USE_ROUTES]
+
+export default router;

package/Templates/base/js/server.js

@@ -0,0 +1,21 @@
+import app from './app.js';
+import { config } from './config/index.js';
+import { connectDB } from './config/db.js';
+
+const start = async () => {
+  try {
+    if (connectDB) {
+      await connectDB();
+    }
+
+    app.listen(config.port, () => {
+      console.log(`🚀 Server running on port ${config.port}`);
+    });
+
+  } catch (err) {
+    console.error('❌ Failed to start server:', err);
+    process.exit(1);
+  }
+};
+
+start();

package/Templates/base/js/utils/asyncHandler.js

@@ -0,0 +1,5 @@
+export const asyncHandler = (fn) => {
+  return function (req, res, next) {
+    Promise.resolve(fn(req, res, next)).catch(next);
+  };
+};

package/Templates/base/ts/app.ts

@@ -0,0 +1,19 @@
+import express from 'express';
+import cors from 'cors';
+import routes from './routes/index.js';
+import { errorHandler } from './middlewares/error.middleware.js';
+
+const app = express();
+
+app.use(cors());
+app.use(express.json());
+
+app.use('/api', routes);
+
+app.get('/health', (_, res) => {
+  res.json({ status: 'OK' });
+});
+
+app.use(errorHandler);
+
+export default app;

package/Templates/base/ts/config/index.ts

@@ -0,0 +1,18 @@
+import dotenv from 'dotenv';
+
+dotenv.config();
+
+export const config = {
+  port: process.env.PORT || 3000,
+
+  // MongoDB
+  mongoUri: process.env.MONGO_URI,
+
+  // MySQL
+  mysql: {
+    host: process.env.MYSQL_HOST,
+    user: process.env.MYSQL_USER,
+    password: process.env.MYSQL_PASSWORD,
+    database: process.env.MYSQL_DATABASE
+  }
+};

package/Templates/base/ts/middlewares/error.middleware.ts

@@ -0,0 +1,15 @@
+import { Request, Response, NextFunction } from 'express';
+
+export const errorHandler = (
+  err: any,
+  _req: Request,
+  res: Response,
+  _next: NextFunction
+) => {
+  console.error(err);
+
+  res.status(err.status || 500).json({
+    success: false,
+    message: err.message || 'Internal Server Error',
+  });
+};

package/Templates/base/ts/routes/index.ts

@@ -0,0 +1,12 @@
+import { Router } from 'express';
+import userRoutes from '../modules/user/user.routes.js';
+
+// [IMPORT_ROUTES]
+
+const router = Router();
+
+router.use('/users', userRoutes);
+
+// [USE_ROUTES]
+
+export default router;

package/Templates/base/ts/server.ts

@@ -0,0 +1,21 @@
+import app from './app.js';
+import { config } from './config/index.js';
+import { connectDB } from './config/db.js';
+
+const start = async () => {
+  try {
+    if (connectDB) {
+      await connectDB();
+    }
+
+    app.listen(config.port, () => {
+      console.log(`🚀 Server running on port ${config.port}`);
+    });
+
+  } catch (err) {
+    console.error('❌ Failed to start server:', err);
+    process.exit(1);
+  }
+};
+
+start();

package/Templates/base/ts/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+
+    "rootDir": "src",
+    "outDir": "dist",
+
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "dist"]
+}

package/Templates/base/ts/utils/asyncHandler.ts

@@ -0,0 +1,5 @@
+export const asyncHandler = (fn: Function) => {
+  return function (req: any, res: any, next: any) {
+    Promise.resolve(fn(req, res, next)).catch(next);
+  };
+};

package/Templates/db/mongodb/js/db.js

@@ -0,0 +1,39 @@
+import mongoose from 'mongoose';
+import dotenv from 'dotenv';
+
+dotenv.config();
+
+const connectDB = async () => {
+  try {
+    await mongoose.connect(process.env.MONGO_URI);
+    console.log('MongoDB connected');
+  } catch (err) {
+    console.error(err);
+    process.exit(1);
+  }
+};
+
+const userSchema = new mongoose.Schema(
+  {
+    name: String,
+    email: String,
+    password: String
+  },
+  { timestamps: true }
+);
+
+const User = mongoose.model('User', userSchema);
+
+// CRUD
+
+export const getAllUsers = async () => User.find();
+
+export const getUserById = async (id) => User.findById(id);
+
+export const createUser = async (data) => User.create(data);
+
+export const updateUser = async (id, data) =>
+  User.findByIdAndUpdate(id, data, { new: true });
+
+export const deleteUser = async (id) =>
+  User.findByIdAndDelete(id);

package/Templates/db/mongodb/ts/db.ts

@@ -0,0 +1,50 @@
+import mongoose from 'mongoose';
+import dotenv from 'dotenv';
+
+dotenv.config();
+
+const connectDB = async (): Promise<void> => {
+  try {
+    await mongoose.connect(process.env.MONGO_URI as string);
+    console.log('MongoDB connected');
+  } catch (err) {
+    console.error(err);
+    process.exit(1);
+  }
+};
+
+interface IUser {
+  name: string;
+  email: string;
+  password: string;
+}
+
+const userSchema = new mongoose.Schema<IUser>(
+  {
+    name: String,
+    email: String,
+    password: String
+  },
+  { timestamps: true }
+);
+
+const User = mongoose.model<IUser>('User', userSchema);
+
+// CRUD
+
+export const getAllUsers = async () => User.find();
+
+export const getUserById = async (id: string) =>
+  User.findById(id);
+
+export const createUser = async (data: IUser) =>
+  User.create(data);
+
+export const updateUser = async (
+  id: string,
+  data: Partial<IUser>
+) =>
+  User.findByIdAndUpdate(id, data, { new: true });
+
+export const deleteUser = async (id: string) =>
+  User.findByIdAndDelete(id);

package/Templates/db/mysql/js/db.js

@@ -0,0 +1,58 @@
+import mysql from 'mysql2/promise';
+import dotenv from 'dotenv';
+
+dotenv.config();
+
+const pool = mysql.createPool({
+  host: process.env.MYSQL_HOST,
+  user: process.env.MYSQL_USER,
+  password: process.env.MYSQL_PASSWORD,
+  database: process.env.MYSQL_DATABASE
+});
+
+export const connectDB = async () => {
+  try {
+    await pool.getConnection();
+    console.log('MySQL connected');
+  } catch (err) {
+    console.error(err);
+    process.exit(1);
+  }
+};
+
+// CRUD
+
+export const getAllUsers = async () => {
+  const [rows] = await pool.query('SELECT * FROM users');
+  return rows;
+};
+
+export const getUserById = async (id) => {
+  const [rows] = await pool.query(
+    'SELECT * FROM users WHERE id = ?',
+    [id]
+  );
+  return rows[0];
+};
+
+export const createUser = async ({ name, email, password }) => {
+  const [result] = await pool.query(
+    'INSERT INTO users (name, email, password) VALUES (?, ?, ?)',
+    [name, email, password]
+  );
+
+  return getUserById(result.insertId);
+};
+
+export const updateUser = async (id, data) => {
+  await pool.query(
+    'UPDATE users SET name=?, email=?, password=? WHERE id=?',
+    [data.name, data.email, data.password, id]
+  );
+
+  return getUserById(id);
+};
+
+export const deleteUser = async (id) => {
+  await pool.query('DELETE FROM users WHERE id=?', [id]);
+};