create-fullstack-boilerplate 1.0.0

package/lib/setupExtraDB.js

@@ -0,0 +1,172 @@
+const path = require("path");
+const { ensure } = require("./utils");
+const fs = ensure("fs-extra");
+
+module.exports = async function setupExtraDB(targetDir, dbConfig) {
+    const backendDir = path.join(targetDir, "backend");
+    const modelsDir = path.join(backendDir, "Models");
+    const dbDir = path.join(backendDir, "DB");
+
+    // 1. Create folder for this DB's models
+    const dbFolderName = dbConfig.dbKey;
+    const dbModelsFolder = path.join(modelsDir, dbFolderName);
+    await fs.ensureDir(dbModelsFolder);
+
+    // 2. Create config file for this DB
+    const configFileName = `${dbFolderName}.config.js`;
+    const configPath = path.join(dbDir, configFileName);
+    
+    const configContent = `module.exports = {
+  development: {
+    username: process.env.${dbConfig.dbKey}_USER || "${dbConfig.username}",
+    password: process.env.${dbConfig.dbKey}_PASSWORD || "${dbConfig.password}",
+    database: process.env.${dbConfig.dbKey}_NAME || "${dbConfig.database}",
+    host: process.env.${dbConfig.dbKey}_HOST || "${dbConfig.host}",
+    port: process.env.${dbConfig.dbKey}_PORT || ${dbConfig.port},
+    dialect: "${dbConfig.dialect}"
+  },
+  test: {
+    username: process.env.${dbConfig.dbKey}_USER || "${dbConfig.username}",
+    password: process.env.${dbConfig.dbKey}_PASSWORD || "${dbConfig.password}",
+    database: process.env.${dbConfig.dbKey}_NAME || "${dbConfig.database}",
+    host: process.env.${dbConfig.dbKey}_HOST || "${dbConfig.host}",
+    port: process.env.${dbConfig.dbKey}_PORT || ${dbConfig.port},
+    dialect: "${dbConfig.dialect}"
+  },
+  production: {
+    username: process.env.${dbConfig.dbKey}_USER,
+    password: process.env.${dbConfig.dbKey}_PASSWORD,
+    database: process.env.${dbConfig.dbKey}_NAME,
+    host: process.env.${dbConfig.dbKey}_HOST,
+    port: process.env.${dbConfig.dbKey}_PORT,
+    dialect: "${dbConfig.dialect}"
+  }
+};
+`;
+
+    await fs.writeFile(configPath, configContent);
+
+    // 3. Create a sample model file
+    const modelContent = generateModelContent(dbConfig);
+    const modelFileName = `${dbConfig.tableName}.js`;
+    const modelPath = path.join(dbModelsFolder, modelFileName);
+    await fs.writeFile(modelPath, modelContent);
+
+    // 4. Update dbConfigs.js to register this DB
+    const dbConfigsPath = path.join(dbDir, "dbConfigs.js");
+    let dbConfigsContent = await fs.readFile(dbConfigsPath, "utf8");
+    
+    const newEntry = `  {
+    key: "${dbConfig.dbKey}",
+    folder: "${dbConfig.dbKey}",
+    configPath: "/../DB/${configFileName}"
+  }`;
+
+    // Insert before the closing bracket
+    dbConfigsContent = dbConfigsContent.replace(
+        /const dbConfigs = \[\s*\];/,
+        `const dbConfigs = [
+${newEntry}
+];`
+    );
+
+    // If there are already entries, append
+    if (!dbConfigsContent.includes(newEntry) && dbConfigsContent.includes("const dbConfigs = [")) {
+        dbConfigsContent = dbConfigsContent.replace(
+            /(const dbConfigs = \[[\s\S]*?)(\];)/,
+            `$1,
+${newEntry}
+$2`
+        );
+    }
+
+    await fs.writeFile(dbConfigsPath, dbConfigsContent);
+
+    // 5. Update .env file with DB credentials
+    const envPath = path.join(backendDir, ".env");
+    let envContent = await fs.readFile(envPath, "utf8");
+    
+    const envVars = `\n# ${dbConfig.dbKey} Database Configuration\n${dbConfig.dbKey}_USER=${dbConfig.username}\n${dbConfig.dbKey}_PASSWORD=${dbConfig.password}\n${dbConfig.dbKey}_NAME=${dbConfig.database}\n${dbConfig.dbKey}_HOST=${dbConfig.host}\n${dbConfig.dbKey}_PORT=${dbConfig.port}\n`;
+    
+    if (!envContent.includes(`${dbConfig.dbKey}_USER`)) {
+        envContent += envVars;
+        await fs.writeFile(envPath, envContent);
+    }
+
+    console.log(`✅ Database '${dbConfig.dbKey}' configured successfully.`);
+};
+
+function generateModelContent(dbConfig) {
+    const modelName = dbConfig.tableName.charAt(0).toUpperCase() + dbConfig.tableName.slice(1);
+    
+    // Generate model content based on whether attributes were provided
+    if (dbConfig.attributes && dbConfig.attributes.length > 0) {
+        const attributesStr = dbConfig.attributes.map(attr => {
+            let attrDef = `    ${attr.name}: {\n      type: DataTypes.${attr.type}`;
+            
+            if (attr.length) {
+                attrDef += `(${attr.length})`;
+            }
+            
+            if (attr.primaryKey) {
+                attrDef += `,\n      primaryKey: true,\n      autoIncrement: true`;
+            }
+            
+            if (attr.allowNull === false) {
+                attrDef += `,\n      allowNull: false`;
+            }
+            
+            if (attr.unique) {
+                attrDef += `,\n      unique: true`;
+            }
+            
+            if (attr.defaultValue !== undefined) {
+                attrDef += `,\n      defaultValue: ${JSON.stringify(attr.defaultValue)}`;
+            }
+            
+            attrDef += `\n    }`;
+            return attrDef;
+        }).join(',\n');
+
+        return `'use strict';
+module.exports = (sequelize, DataTypes) => {
+  const ${modelName} = sequelize.define('${modelName}', {
+${attributesStr}
+  }, {
+    tableName: '${dbConfig.tableName}',
+    timestamps: true
+  });
+
+  ${modelName}.associate = function(models) {
+    // Define associations here
+    // Example: ${modelName}.belongsTo(models.OtherModel, { foreignKey: 'otherId' });
+  };
+
+  return ${modelName};
+};
+`;
+    } else {
+        // Simple model with just ID
+        return `'use strict';
+module.exports = (sequelize, DataTypes) => {
+  const ${modelName} = sequelize.define('${modelName}', {
+    id: {
+      type: DataTypes.INTEGER,
+      primaryKey: true,
+      autoIncrement: true
+    }
+  }, {
+    tableName: '${dbConfig.tableName}',
+    timestamps: true
+  });
+
+  ${modelName}.associate = function(models) {
+    // Define associations here
+    // Example: ${modelName}.belongsTo(models.OtherModel, { foreignKey: 'otherId' });
+  };
+
+  return ${modelName};
+};
+`;
+    }
+}

package/lib/setupMainDB.js

@@ -0,0 +1,9 @@
+const { replaceInFiles, log } = require("./utils");
+
+module.exports = async function setupMainDB(targetDir, dialect) {
+    log("Configuring main DB in backend...");
+    await replaceInFiles(targetDir, {
+        "__DB_DIALECT__": dialect
+    });
+    console.log("✅ Main DB configured.");
+};

package/lib/testDBConnection.js

@@ -0,0 +1,31 @@
+const path = require("path");
+
+async function testDBConnection(targetDir, dbConfig) {
+    const sequelizePath = path.join(targetDir, "backend", "node_modules", "sequelize");
+    const { Sequelize } = require(sequelizePath);
+
+    const sequelize = new Sequelize(
+        dbConfig.database,
+        dbConfig.username,
+        dbConfig.password,
+        {
+            host: dbConfig.host,
+            port: dbConfig.port,
+            dialect: dbConfig.dialect,
+            logging: false
+        }
+    );
+
+    try {
+        await sequelize.authenticate();
+        console.log(`✅ Connection successful to ${dbConfig.dbKey}`);
+        await sequelize.close();
+        return true;
+    } catch (err) {
+        console.log(`❌ Failed to connect to ${dbConfig.dbKey}`);
+        console.log("Error:", err.message);
+        return false;
+    }
+}
+
+module.exports = testDBConnection;

package/lib/utils.js

@@ -0,0 +1,39 @@
+const { execSync } = require("child_process");
+
+function ensure(dep) {
+    try {
+        return require(dep);
+    } catch (e) {
+        console.log(`📦 Installing missing dependency: ${dep}...`);
+        execSync(`npm install ${dep} --silent`, { cwd: __dirname + "/..", stdio: "inherit" });
+        return require(dep);
+    }
+}
+
+function log(step) {
+    console.log(`\n➡️  ${step}`);
+}
+
+const fs = ensure("fs-extra");
+const path = require("path");
+
+async function replaceInFiles(base, replacements) {
+    const exts = [".js", ".ts", ".json", ".md", ".env", ".yml"];
+    async function walk(dir) {
+        for (const item of await fs.readdir(dir)) {
+            const fullPath = path.join(dir, item);
+            const stat = await fs.stat(fullPath);
+            if (stat.isDirectory()) await walk(fullPath);
+            else if (exts.includes(path.extname(fullPath))) {
+                let data = await fs.readFile(fullPath, "utf8");
+                for (const [k, v] of Object.entries(replacements)) {
+                    data = data.replaceAll(k, v);
+                }
+                await fs.writeFile(fullPath, data);
+            }
+        }
+    }
+    await walk(base);
+}
+
+module.exports = { ensure, log, replaceInFiles };

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "create-fullstack-boilerplate",
+  "version": "1.0.0",
+  "description": "A Full Stack Application Comprised of React for Frontend, Express & Sequelize with Node js for Backend to help developers get started on real implementation instead of spending time setting up projects.",
+  "main": "index.js",
+  "bin": {
+    "create-fullstack-boilerplate": "index.js"
+  },
+  "preferGlobal": false,
+  "engines": {
+    "node": ">=20"
+  },
+  "files": [
+    "index.js",
+    "lib",
+    "template"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mhuzaifi0604/react-boilerplate.git"
+  },
+  "keywords": [
+    "fullstack",
+    "boilerplate",
+    "react",
+    "node",
+    "js",
+    "fullstack",
+    "app"
+  ],
+  "dependencies": {
+    "execa": "^5.1.1",
+    "fs-extra": "^11.3.2",
+    "inquirer": "^8.2.7"
+  },
+  "author": "Muhammad Huzaifa",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/mhuzaifi0604/react-boilerplate/issues"
+  },
+  "homepage": "https://github.com/mhuzaifi0604/react-boilerplate#readme"
+}

package/template/Backend/.env

@@ -0,0 +1,7 @@
+# Server Configuration
+PORT=5000
+CLIENT_URL=http://localhost:5173
+
+# Security Credentials
+JWT_SECRET=PMD_SUP3R_S3CR37_JW7_T0K3N
+PASSWORD_ENCRYPTION_KEY=A35_5YM37R1C_3NCRYP710N_K3Y_PMD

package/template/Backend/DB/DBInit.js

@@ -0,0 +1,28 @@
+const colors = require('colors');
+
+const RETRY_DELAY_MS = 3000;
+const MAX_RETRIES = 5;
+
+async function initializeDatabaseConnection(sequelize, name = 'Database') {
+    let retries = 0;
+
+    while (retries < MAX_RETRIES) {
+        try {
+            await sequelize.authenticate();
+            console.log(`[✅] - ${name} connection established.`.green);
+            await sequelize.sync();
+            return true;
+        } catch (error) {
+            console.error(`\n[!] ${name} connection failed: ${error.message}\n`.red);
+            retries++;
+            if (retries >= MAX_RETRIES) {
+                console.error(`\n[❌] ${name} could not connect after ${MAX_RETRIES} attempts.\n`.bgRed.white);
+                throw error;
+            }
+            console.log(`\n[↻] Retrying ${name} in ${RETRY_DELAY_MS / 1000} seconds...\n`.yellow);
+            await new Promise(res => setTimeout(res, RETRY_DELAY_MS));
+        }
+    }
+}
+
+module.exports = { initializeDatabaseConnection };

package/template/Backend/DB/dbConfigs.js

@@ -0,0 +1,4 @@
+const dbConfigs = [
+];
+
+module.exports = dbConfigs;

package/template/Backend/Models/index.js

@@ -0,0 +1,54 @@
+'use strict';
+
+require('dotenv').config();
+const fs = require('fs');
+const path = require('path');
+const Sequelize = require('sequelize');
+const dbConfigs = require('../DB/dbConfigs')
+const basename = path.basename(__filename);
+const env = process.env.NODE_ENV || 'development';
+
+
+const databases = {};
+
+for (const { key, folder, configPath } of dbConfigs) {
+  const config = require(__dirname + configPath)[env];
+  let sequelize;
+
+  if (config.use_env_variable) {
+    sequelize = new Sequelize(process.env[config.use_env_variable], config);
+  } else {
+    sequelize = new Sequelize(config.database, config.user, config.password, config);
+  }
+
+  const db = {};
+
+  // Load regular models in CMPA folder (excluding operatorCmpaModel.js)
+  fs.readdirSync(path.join(__dirname, folder))
+    .filter(file =>
+      file.indexOf('.') !== 0 &&
+      file.slice(-3) === '.js' &&
+      file !== basename &&
+      !file.includes('.test.js')
+    )
+    .forEach(file => {
+      const model = require(path.join(__dirname, folder, file))(sequelize, Sequelize.DataTypes);
+      db[model.name] = model;
+    });
+
+
+  // Setup associations
+  Object.keys(db).forEach(modelName => {
+    if (db[modelName].associate) {
+      db[modelName].associate(db);
+    }
+  });
+
+  db.sequelize = sequelize;
+  db.Sequelize = Sequelize;
+
+  // Store under key (e.g., CRM_DB, CMPA_DB, etc.)
+  databases[key] = db;
+}
+
+module.exports = databases;