create-fullstack-boilerplate 1.0.0

package/README.md

@@ -0,0 +1,390 @@
+# create-fullstack-app
+
+A powerful CLI tool to quickly scaffold a complete fullstack application with React, Node.js, Express, and Sequelize with multi-database support. Get started building real features instead of spending time on project setup!
+
+## ✨ Features
+
+- 🚀 **Quick Setup** - Create a production-ready fullstack project in minutes
+- 🗄️ **Multi-Database Support** - Connect to multiple databases (MySQL, MariaDB, PostgreSQL)
+- 🔧 **Interactive CLI** - User-friendly prompts guide you through setup
+- 📦 **Modern Stack** - React 19, Node.js 20+, Express, Sequelize, Tailwind CSS, DaisyUI
+- 🔌 **Dynamic Database Addition** - Add new databases to existing projects
+- 🛣️ **Route Generator** - Quickly scaffold new API endpoints with services
+- 🔐 **Authentication Ready** - JWT-based authentication out of the box
+- 📝 **Comprehensive Documentation** - Detailed READMEs for both frontend and backend
+- 🎯 **Best Practices** - Following industry-standard project structure
+
+## 📋 Prerequisites
+
+- **Node.js** >= 20.0.0
+- **npm** or **yarn**
+- **Database Server** (MySQL, MariaDB, or PostgreSQL)
+
+## 🚀 Quick Start
+
+### Create a New Project
+
+```bash
+npx create-fullstack-app
+```
+
+Or install globally:
+
+```bash
+npm install -g create-fullstack-app
+create-fullstack-app
+```
+
+Follow the interactive prompts:
+
+1. Enter your project name
+2. Choose your main database dialect (MySQL, MariaDB, or PostgreSQL)
+3. Optionally add an extra database
+4. Optionally initialize a Git repository
+
+The tool will:
+- ✅ Copy project template files
+- ✅ Configure databases
+- ✅ Install all dependencies
+- ✅ Test database connections
+- ✅ Set up environment variables
+
+### Start Development
+
+```bash
+cd your-project-name
+
+# Start backend server
+cd backend
+npm run dev
+
+# In another terminal, start frontend
+cd frontend
+npm run dev
+```
+
+- Backend runs on: `http://localhost:5000`
+- Frontend runs on: `http://localhost:5173`
+
+## 🗄️ Database Management
+
+### Add a Database to Existing Project
+
+Navigate to your project root and run:
+
+```bash
+npx create-fullstack-app add-db
+```
+
+The CLI will prompt you for:
+- Database identifier (e.g., `REPORTING_DB`, `ANALYTICS_DB`)
+- Database credentials (host, port, username, password)
+- Database name
+- Table/model name
+- Whether to define table attributes now
+
+#### Defining Table Attributes
+
+When adding a database, you can choose to define your table schema interactively:
+
+1. **Primary Key**: Define your primary key column (name, type, auto-increment)
+2. **Other Attributes**: Add as many columns as needed with:
+   - Column name
+   - Data type (dialect-specific options)
+   - Length/precision (for VARCHAR, DECIMAL, etc.)
+   - Constraints (NOT NULL, UNIQUE, DEFAULT values)
+
+The tool automatically:
+- Creates a folder in `Models/[DB_NAME]/`
+- Generates the model file with your schema
+- Creates database configuration file
+- Updates `DB/dbConfigs.js`
+- Adds credentials to `.env`
+- Tests the database connection
+
+### Data Types by Dialect
+
+The CLI provides appropriate data types based on your selected database dialect:
+
+**MySQL/MariaDB:**
+- INTEGER, BIGINT, FLOAT, DOUBLE, DECIMAL
+- STRING (VARCHAR), TEXT
+- BOOLEAN, DATE, DATETIME, TIME
+- JSON, BLOB, ENUM
+
+**PostgreSQL:**
+- INTEGER, BIGINT, FLOAT, DOUBLE, DECIMAL
+- STRING (VARCHAR), TEXT
+- BOOLEAN, DATE, TIMESTAMP, TIME
+- JSON, JSONB, BYTEA, UUID, ARRAY, ENUM
+
+## 🛣️ Route Management
+
+### Add a New Route
+
+Navigate to your project root and run:
+
+```bash
+npx create-fullstack-app add-route
+```
+
+The CLI will prompt you for:
+- Route name (e.g., `users`, `products`)
+- Route path (e.g., `/users`)
+- Whether authentication is required
+
+This automatically:
+- ✅ Creates `routes/[routeName]Routes.js` with CRUD endpoints
+- ✅ Creates `services/[routeName]Service.js` with business logic stubs
+- ✅ Updates `routes/index.js` to register the new route
+- ✅ Applies authentication middleware if requested
+
+### Generated Route Structure
+
+```javascript
+// routes/usersRoutes.js
+GET    /users      - Get all users
+GET    /users/:id  - Get user by ID
+POST   /users      - Create new user
+PUT    /users/:id  - Update user
+DELETE /users/:id  - Delete user
+```
+
+Each route delegates to a corresponding service function where you implement your business logic.
+
+## 📁 Project Structure
+
+```
+your-project/
+├── backend/
+│   ├── DB/                    # Database configurations
+│   │   ├── DBInit.js         # Connection initialization
+│   │   ├── dbConfigs.js      # Database registry
+│   │   └── [DB].config.js    # Individual DB configs
+│   ├── Models/               # Sequelize models
+│   │   ├── index.js         # Model loader
+│   │   └── [DB_NAME]/       # Models per database
+│   ├── routes/              # API endpoints
+│   │   ├── index.js        # Main router
+│   │   └── *Routes.js      # Feature routes
+│   ├── services/           # Business logic
+│   │   └── *Service.js    # Service functions
+│   ├── middleware/        # Express middleware
+│   ├── .env              # Environment variables
+│   ├── package.json
+│   ├── server.js        # Application entry
+│   └── README.md       # Backend documentation
+└── frontend/
+    ├── src/
+    │   ├── components/  # React components
+    │   ├── pages/      # Page components
+    │   ├── services/   # API clients
+    │   ├── App.jsx
+    │   └── main.jsx
+    ├── public/
+    ├── .env
+    ├── package.json
+    ├── vite.config.js
+    └── README.md      # Frontend documentation
+```
+
+## 🔧 Configuration
+
+### Backend Environment Variables
+
+```env
+# Server
+PORT=5000
+CLIENT_URL=http://localhost:5173
+
+# Security
+JWT_SECRET=your_jwt_secret
+PASSWORD_ENCRYPTION_KEY=your_encryption_key
+
+# Database Example (created when you add a database)
+MAIN_DB_USER=root
+MAIN_DB_PASSWORD=password
+MAIN_DB_NAME=mydb
+MAIN_DB_HOST=localhost
+MAIN_DB_PORT=3306
+```
+
+### Frontend Environment Variables
+
+```env
+VITE_API_URL=http://localhost:5000/api
+```
+
+**Important:** Vite requires environment variables to be prefixed with `VITE_`.
+
+## 💻 Usage Examples
+
+### Accessing Databases in Your Code
+
+```javascript
+// Import all databases
+const databases = require('./Models');
+
+// Access specific database
+const { MAIN_DB, REPORTING_DB } = databases;
+
+// Use models
+const { User, Product } = MAIN_DB;
+
+// Sequelize operations
+const users = await User.findAll();
+const user = await User.findByPk(1);
+await User.create({ name: 'John', email: 'john@example.com' });
+```
+
+### Creating API Endpoints
+
+After generating a route with `add-route`, implement your service logic:
+
+```javascript
+// services/usersService.js
+const { MAIN_DB } = require('../Models');
+const { User } = MAIN_DB;
+
+exports.getAll = async (req, res) => {
+  try {
+    const users = await User.findAll();
+    res.json(users);
+  } catch (error) {
+    res.status(500).json({ message: 'Error fetching users', error: error.message });
+  }
+};
+```
+
+### Making API Calls from Frontend
+
+```javascript
+// src/services/api.js
+import axios from 'axios';
+
+const api = axios.create({
+  baseURL: import.meta.env.VITE_API_URL
+});
+
+// Add auth token to requests
+api.interceptors.request.use((config) => {
+  const token = localStorage.getItem('token');
+  if (token) {
+    config.headers.Authorization = `Bearer ${token}`;
+  }
+  return config;
+});
+
+export default api;
+
+// src/services/userService.js
+import api from './api';
+
+export const getUsers = () => api.get('/users');
+export const createUser = (data) => api.post('/users', data);
+```
+
+## 📚 Technology Stack
+
+### Backend
+- **Node.js** - JavaScript runtime
+- **Express** - Web framework
+- **Sequelize** - ORM for SQL databases
+- **JWT** - Authentication
+- **bcryptjs** - Password hashing
+- **colors** - Terminal output styling
+- **dotenv** - Environment variable management
+
+### Frontend
+- **React 19** - UI library
+- **Vite** - Build tool
+- **Tailwind CSS 4** - Utility-first CSS
+- **DaisyUI** - Component library
+- **React Router** - Routing
+- **Axios** - HTTP client
+- **Recharts** - Data visualization
+
+## 🎯 Best Practices
+
+1. **Environment Variables**: Never commit `.env` files
+2. **Database Models**: Organize models by database
+3. **Service Layer**: Keep business logic in services, not routes
+4. **Error Handling**: Always handle errors and provide meaningful messages
+5. **Authentication**: Use JWT tokens stored in localStorage
+6. **Validation**: Validate input on both client and server
+7. **Documentation**: Update READMEs when adding features
+
+## 🔒 Security Considerations
+
+- Change default JWT secrets in production
+- Use environment variables for sensitive data
+- Implement rate limiting for APIs
+- Sanitize user inputs
+- Use HTTPS in production
+- Keep dependencies updated
+
+## 🐛 Troubleshooting
+
+### Command Not Found
+
+```bash
+# Reinstall the package globally
+npm install -g create-fullstack-app
+```
+
+### Database Connection Failed
+
+- Verify database server is running
+- Check credentials in `.env`
+- Ensure database exists
+- Check network connectivity
+- Verify port is not blocked
+
+### Port Already in Use
+
+```bash
+# Windows
+netstat -ano | findstr :5000
+taskkill /PID <PID> /F
+
+# Linux/Mac
+lsof -i :5000
+kill -9 <PID>
+```
+
+### Module Not Found
+
+```bash
+# Reinstall dependencies
+cd backend && npm install
+cd ../frontend && npm install
+```
+
+## 📖 Additional Documentation
+
+After creating your project, refer to:
+
+- `backend/README.md` - Complete backend documentation including Sequelize usage
+- `frontend/README.md` - Complete frontend documentation including React patterns
+
+## 🤝 Contributing
+
+Found a bug or have a feature request? Please open an issue on GitHub.
+
+## 📝 License
+
+ISC
+
+## 👨‍💻 Author
+
+Muhammad Huzaifa
+
+## 🙏 Acknowledgments
+
+Built with modern tools and best practices to help developers start building features faster!
+
+---
+
+**Happy Coding! 🚀**
+
+Get started in minutes, not hours. Focus on building features, not boilerplate.

package/index.js

@@ -0,0 +1,78 @@
+#!/usr/bin/env node
+
+(async () => {
+    const argv = process.argv.slice(2);
+
+    if (argv[0] === "add-db") {
+        await require("./lib/addDB")();
+        return;
+    }
+
+    if (argv[0] === "add-route") {
+        await require("./lib/addRoute")();
+        return;
+    }
+
+    // ---- Your existing create-project code ----
+    const path = require("path");
+    const { ensure } = require("./lib/utils");
+    const copyProject = require("./lib/copyProject");
+    const installDeps = require("./lib/installDeps");
+    const setupMainDB = require("./lib/setupMainDB");
+    const setupExtraDB = require("./lib/setupExtraDB");
+    const testDBConnection = require("./lib/testDBConnection");
+    const { mainPrompts, extraDBPrompts } = require("./lib/prompts");
+
+    const fs = ensure("fs-extra");
+
+    try {
+        console.log("\n🎛️  Setting Up Full Stack Project...\n");
+
+        const answers = await mainPrompts();
+        const templateDir = path.join(__dirname, "template");
+        const targetDir = path.join(process.cwd(), answers.projectName);
+
+        await copyProject(templateDir, targetDir);
+        await setupMainDB(targetDir, answers.dbDialect);
+        await installDeps(targetDir);
+
+        if (answers.addExtraDB) {
+            const extraDB = await extraDBPrompts();
+            console.log(`\n🔍 Testing connection for ${extraDB.dbKey}...`);
+            const ok = await testDBConnection(targetDir, extraDB);
+
+            if (ok) {
+                await setupExtraDB(targetDir, extraDB);
+                console.log(`✅ Extra DB '${extraDB.dbKey}' successfully integrated.\n`);
+            } else {
+                console.log(`⚠️ Connection failed. Skipping extra DB setup.\n`);
+            }
+        }
+
+        if (answers.initGit) {
+            try {
+                const execa = require("execa").execa || require("execa");
+                await execa("git", ["init"], { cwd: targetDir });
+                if (answers.remoteRepo) {
+                    await execa("git", ["remote", "add", "origin", answers.remoteRepo], { cwd: targetDir });
+                }
+                console.log("✅ Git initialized.\n");
+            } catch (gitErr) {
+                console.log(`⚠️ Git initialization failed: ${gitErr.message}`);
+                console.log(`   You can initialize git manually later.\n`);
+            }
+        }
+
+        console.log(`\n🎉 Project Ready!`);
+        console.log(`\n➡️ Next Steps:`);
+        console.log(`   cd ${answers.projectName}`);
+        console.log(`   cd backend && npm run dev`);
+        console.log(`   cd ../frontend && npm run dev\n`);
+    } catch (err) {
+        console.error(`\n❌ Error creating project: ${err.message}\n`);
+        if (err.stack && process.env.DEBUG) {
+            console.error(err.stack);
+        }
+        process.exit(1);
+    }
+})();

package/lib/addDB.js

@@ -0,0 +1,77 @@
+const path = require("path");
+const { extraDBPrompts } = require("./prompts");
+const testDBConnection = require("./testDBConnection");
+const setupExtraDB = require("./setupExtraDB");
+const { ensure } = require("./utils");
+const fs = ensure("fs-extra");
+
+module.exports = async function addDB() {
+    console.log(`\n➕ Add New Database to Existing Project\n`);
+
+    const targetDir = process.cwd();
+    const backendDir = path.join(targetDir, "backend");
+    const dbDir = path.join(backendDir, "DB");
+    const modelsDir = path.join(backendDir, "Models");
+
+    // Check if we're in a valid project
+    if (!await fs.pathExists(backendDir)) {
+        console.log(`❌ Error: No backend folder found. Are you in a project root directory?`);
+        console.log(`   Run this command from your project root (where backend/ folder exists).`);
+        return;
+    }
+
+    if (!await fs.pathExists(dbDir)) {
+        console.log(`❌ Error: No DB folder found in backend. This doesn't appear to be a valid project.`);
+        return;
+    }
+
+    if (!await fs.pathExists(modelsDir)) {
+        console.log(`❌ Error: No Models folder found in backend. This doesn't appear to be a valid project.`);
+        return;
+    }
+
+    try {
+        // Ask DB info
+        const extraDB = await extraDBPrompts();
+
+        // Check if DB with same key already exists
+        const dbConfigsPath = path.join(dbDir, "dbConfigs.js");
+        if (await fs.pathExists(dbConfigsPath)) {
+            const dbConfigsContent = await fs.readFile(dbConfigsPath, "utf8");
+            if (dbConfigsContent.includes(`key: "${extraDB.dbKey}"`)) {
+                console.log(`\n⚠️  Database with key '${extraDB.dbKey}' already exists in the project.`);
+                console.log(`   Please use a different DB identifier.\n`);
+                return;
+            }
+        }
+
+        // Check if DB folder already exists
+        const dbFolder = path.join(modelsDir, extraDB.dbKey);
+        if (await fs.pathExists(dbFolder)) {
+            console.log(`\n⚠️  Folder '${extraDB.dbKey}' already exists in Models directory.`);
+            console.log(`   Please use a different DB identifier.\n`);
+            return;
+        }
+
+        console.log(`\n🔍 Testing connection for ${extraDB.dbKey}...\n`);
+        const ok = await testDBConnection(targetDir, extraDB);
+
+        if (!ok) {
+            console.log(`❌ Connection failed. DB not added.\n`);
+            return;
+        }
+
+        await setupExtraDB(targetDir, extraDB);
+        console.log(`\n✅ Successfully added ${extraDB.dbKey} to project.\n`);
+        console.log(`📝 Next steps:`);
+        console.log(`   1. Check backend/.env for database credentials`);
+        console.log(`   2. Add more models in backend/Models/${extraDB.dbKey}/`);
+        console.log(`   3. Import and use in your routes: const { ${extraDB.dbKey} } = require('./Models');\n`);
+
+    } catch (err) {
+        console.log(`\n❌ Error adding DB:`, err.message);
+        if (err.stack) {
+            console.log(`\nStack trace:`, err.stack);
+        }
+    }
+};