@amalkrishnakp/mern_launcher 1.0.0

package/README.md

@@ -0,0 +1,249 @@
+# MERN Launcher 🚀
+
+A powerful CLI tool that automates MERN stack project setup, specifically designed for development environments. Get from zero to production-ready development setup in minutes!
+
+## ✨ Features
+
+### 🎯 Complete MERN Stack Setup
+- **MongoDB** with Mongoose ODM and environment configuration
+- **Express.js** server with CORS and development settings
+- **React** with Vite for lightning-fast development
+- **Node.js** backend with modern ES modules
+
+### 🔥 Development Optimized
+- **Hot Reload Development** - Vite for frontend, Nodemon for backend
+- **Development CORS** - Pre-configured for `http://localhost:5173`
+- **Development Scripts** - Ready-to-run `npm run dev` commands
+- **Local Environment** - Perfect for local development and testing
+
+### 🛠️ Built-in Tools & Libraries
+- **Tailwind CSS** - Utility-first CSS framework
+- **shadcn/ui** - Beautiful, accessible UI components
+- **Axios** - HTTP client with development baseURL
+- **Dotenv** - Environment variable management
+- **CORS** - Cross-origin resource sharing
+
+### ⚡ Smart CLI Features
+- **Flexible Setup** - Use current folder or create new project
+- **Interactive Prompts** - User-friendly configuration
+- **Robust Process Management** - Uses Execa for reliable command execution
+- **Cross-Platform** - Works on Windows, Mac, and Linux
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+npx mern-launcher
+```
+
+### Usage
+
+1. **Run the CLI tool:**
+   ```bash
+   npx mern-launcher
+   ```
+
+2. **Answer the interactive prompts:**
+   - Choose to use current folder or create new one
+   - Enter your project name (if creating new folder)
+   - Provide your MongoDB connection string
+
+3. **Start development:**
+   ```bash
+   # Terminal 1 - Backend
+   cd backend
+   npm run dev
+
+   # Terminal 2 - Frontend  
+   cd frontend
+   npm run dev
+   ```
+
+4. **Open your browser:**
+   - Frontend: `http://localhost:5173`
+   - Backend: `http://localhost:5000`
+
+## 📁 Project Structure
+
+```
+your-project/
+├── backend/
+│   ├── src/
+│   │   ├── lib/
+│   │   │   └── db.js
+│   │   └── server.js
+│   ├── .env
+│   └── package.json
+└── frontend/
+    ├── src/
+    │   ├── lib/
+    │   │   └── axios.js
+    │   ├── components/
+    │   │   └── ui/
+    │   ├── App.jsx
+    │   └── index.css
+    ├── jsconfig.json
+    └── vite.config.js
+```
+
+## 🛠️ What Gets Installed
+
+### Backend Dependencies
+- `express` - Web framework
+- `mongoose` - MongoDB ODM
+- `cors` - Cross-origin resource sharing
+- `dotenv` - Environment variables
+- `nodemon` - Development hot reload
+
+### Frontend Dependencies
+- `react` - UI library
+- `vite` - Build tool and dev server
+- `tailwindcss` - CSS framework
+- `@tailwindcss/vite` - Tailwind Vite integration
+- `shadcn/ui` - UI components
+- `axios` - HTTP client
+- `@types/node` - Type definitions
+
+## 🔧 Configuration
+
+### Environment Variables (Backend/.env)
+```env
+NODE_ENV=development
+MONGO_URL=your_mongodb_connection_string
+```
+
+### API Client (Frontend)
+```javascript
+// Pre-configured Axios instance
+import { axiosInstance } from '@/lib/axios'
+
+// Usage in components
+axiosInstance.get('/api/users')
+axiosInstance.post('/api/users', data)
+```
+
+### Development URLs
+- **Frontend**: `http://localhost:5173`
+- **Backend**: `http://localhost:5000`
+- **API Base**: `http://localhost:5000` (in development)
+
+## 🎯 Use Cases
+
+### Perfect For:
+- 🏗️ **Rapid Prototyping** - Quickly test ideas and concepts
+- 🎓 **Learning & Education** - Perfect for students and tutorials
+- 🔬 **Proof of Concepts** - Validate ideas without setup overhead
+- 🚀 **Hackathons** - Get started coding immediately
+- 💼 **Side Projects** - Focus on building, not configuring
+
+### Development Workflow
+1. **Idea** → Have a project idea
+2. **Setup** → Run `npx mern-launcher`
+3. **Develop** → Start coding immediately
+4. **Test** → Both servers running with hot reload
+5. **Deploy** → Ready for production deployment
+
+## 🔄 Development Commands
+
+### Backend
+```bash
+cd backend
+npm run dev    # Start development server with nodemon
+npm start     # Start production server
+```
+
+### Frontend
+```bash
+cd frontend
+npm run dev    # Start Vite development server
+npm run build  # Build for production
+npm run preview # Preview production build
+```
+
+## 🎨 UI Components
+
+The setup includes **shadcn/ui** with pre-configured:
+- Button components
+- Tailwind CSS integration
+- Path aliases (`@/*` for `./src/*`)
+- Responsive design utilities
+
+Example component usage:
+```jsx
+import { Button } from "@/components/ui/button"
+
+function App() {
+  return (
+    <div className="flex min-h-svh flex-col items-center justify-center">
+      <Button>Click me</Button>
+    </div>
+  )
+}
+```
+
+## 🌟 Why Use MERN Launcher?
+
+### Time Savings
+- ⏱️ **Save 1-2 hours** per project on initial setup
+- 🔧 **No configuration headaches** - everything just works
+- 📚 **Best practices** built-in from start
+
+### Developer Experience
+- 🚀 **Instant hot reload** for both frontend and backend
+- 🎯 **Consistent structure** across all projects
+- 🔥 **Modern tooling** with latest versions
+- 📱 **Mobile-responsive** from day one
+
+### Production Ready
+- ⚡ **Optimized build** configuration
+- 🔒 **Security practices** implemented
+- 📦 **Clean, maintainable** code structure
+
+## 🐛 Troubleshooting
+
+### Common Issues
+
+1. **Port already in use**
+   - Check if ports 5173 or 5000 are occupied
+   - Kill existing processes or change ports in configuration
+
+2. **MongoDB connection issues**
+   - Verify your connection string
+   - Ensure MongoDB is running and accessible
+
+3. **Permission errors**
+   - Run with appropriate permissions
+   - Check file/folder permissions in project directory
+
+### Getting Help
+
+- Check the [GitHub Issues](https://github.com/AmalKrishnaKP/MERN_LAUNCHER/issues) page
+- Verify all prerequisites are installed
+- Ensure stable internet connection for package downloads
+
+## 🤝 Contributing
+
+We welcome contributions! Please feel free to submit pull requests, report bugs, or suggest new features.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+## 📝 License
+
+This project is licensed under the ISC License - see the [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+- Built with amazing open-source tools
+- Inspired by the need for faster project setup
+- Thanks to all contributors and users
+
+---
+
+**Happy Coding!** 🚀
+
+If you find this tool helpful, please give it a ⭐ on GitHub!

package/bin/cli.js

@@ -0,0 +1,21 @@
+#!/usr/bin/env node 
+import { createProjectStructure } from "../src/generator/structure.generator.js";
+import { askQuestions } from "../src/prompts/question.prompt.js";
+
+
+
+console.log(process.cwd());
+
+
+const run=async()=>{
+    try {
+        const answer= await askQuestions();   //asking iniital questions
+        
+        await createProjectStructure(answer)        
+    } catch (error) {
+        console.log(error);
+        
+    }
+    
+}
+run();

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@amalkrishnakp/mern_launcher",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AmalKrishnaKP/MERN_LAUNCHER.git"
+  },
+  "type": "module",
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/AmalKrishnaKP/MERN_LAUNCHER/issues"
+  },
+  "bin": {
+    "mern-launcher": "bin/cli.js"
+  },
+  "homepage": "https://github.com/AmalKrishnaKP/MERN_LAUNCHER#readme",
+  "description": "",
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "execa": "^9.6.0",
+    "fs": "^0.0.1-security",
+    "inquirer": "^13.0.1"
+  }
+}

package/src/generator/setupAxios.generator.js

@@ -0,0 +1,25 @@
+import { execa } from 'execa';
+import fs from 'fs'
+import path from 'path';
+
+export const setupAxios=async(frontPath)=>{
+    try {
+        await execa("npm",["install","axios"],{
+            cwd:frontPath,
+            stdio:"inherit"
+        })
+        fs.writeFileSync(path.join(frontPath,"src/lib/axios.js"),`
+import axios from 'axios'
+
+export const axiosInstance=axios.create({
+    baseURL: import.meta.env.MODE==="development"? "http://localhost:5000":"",
+    withCredentials:true,
+})
+
+        `)
+        
+    } catch (error) {
+        console.log(error);
+        
+    }
+}

package/src/generator/setupDotEnv.generator.js

@@ -0,0 +1,14 @@
+import fs from 'fs'
+import path from 'path';
+
+export const setupDotEnv=async(backPath,answer)=>{
+    try {
+        fs.writeFileSync(path.join(backPath,".env"),`
+NODE_ENV=development
+MONGO_URL=${answer.mongoURL}        
+        `)
+    } catch (error) {
+        console.log(error);
+        
+    }
+}

package/src/generator/setupExpress.generator.js

@@ -0,0 +1,51 @@
+import { match } from "assert";
+import { execa } from "execa";
+import fs from 'fs'
+import path from "path";
+import { inherits } from "util";
+
+export const setupExpress=async(backPath)=>{
+    try {
+        await execa("npm",["install","express","cors"],{
+            cwd:backPath,
+            stdio:"inherit"
+        })
+        fs.writeFileSync(path.join(backPath,"src/server.js"),`import express from 'express'
+import dotenv from "dotenv"
+import cors from 'cors'
+
+import { connectDB } from './lib/db.js';
+
+dotenv.config()
+
+const app=express() 
+
+app.use(cors({
+    origin: process.env.NODE_ENV==="development" ? "http://localhost:5173" || true:true,
+    credentials:true,
+}))
+const PORT = process.env.PORT || 5000 
+app.listen(PORT,()=>{
+    console.log("server listening on:" ,PORT);
+    connectDB()
+})
+        
+        `)
+        await execa("npm",["install","node","nodemon"],{
+            cwd:backPath,
+            stdio:"inherit"
+        })
+        const jsonCont=fs.readFileSync(path.join(backPath,"package.json"),'utf8')
+        const updatedJsonCon=jsonCont.replace(/"test": "echo \\"Error: no test specified\\" && exit 1"/,match=>`
+${match},
+"dev": "nodemon src/server.js"`)
+        const moduleUpdate=updatedJsonCon.replace(/{\s*/,`
+{
+    "type": "module",`)
+
+        fs.writeFileSync(path.join(backPath,"package.json"),moduleUpdate)
+    } catch (error) {
+        console.log(error);
+        
+    }
+}

package/src/generator/setupMongo.generator.js

@@ -0,0 +1,28 @@
+import { execa } from "execa";
+import fs from 'fs'
+import path from "path";
+
+export const setupMongo=async(backPath,answer)=>{
+    try {
+        await execa("npm",["install","mongoose","dotenv"])
+        fs.mkdirSync(path.join(backPath,"src/lib"))
+
+        fs.writeFileSync(path.join(backPath,"src/lib/db.js"),`
+import mongoose from 'mongoose'
+
+export const connectDB=async()=>{
+    try {
+        const conn=await mongoose.connect(process.env.MONGO_URL)
+        console.log("connectd in "+ conn.connection.host);
+        
+    } catch (error) {
+        console.log(error); 
+        
+    }
+}
+        `)
+    } catch (error) {
+        console.log(error);
+        
+    }
+}

package/src/generator/setupShadCN.generator.js

@@ -0,0 +1,70 @@
+import { match } from 'assert';
+import { execa } from 'execa';
+import fs from 'fs'
+import path from 'path';
+import { exitCode } from 'process';
+
+export const setupShadCN=async(frontPath)=>{
+    try {
+        const jsConfigPath=path.join(frontPath,"jsconfig.json")
+        const jsConfigContent=`{
+  "files": [],
+  "references": [
+  ],
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  }
+}`
+        fs.writeFileSync(jsConfigPath,jsConfigContent)
+        await execa("npm",["install", "-D", "@types/node"],{
+            cwd:frontPath,
+            stdio:"inherit"
+        })
+        const viteConfigPath=path.join(frontPath,"vite.config.js")
+        const viteConfigContent=fs.readFileSync(viteConfigPath,'utf8')
+        const updatedCon=`import path from "path"\n`+viteConfigContent
+        const finalCont=updatedCon.replace(/plugins:\s*\[[^\]]*\]/,
+            match=>`
+                ${match},
+                resolve: {
+                    alias: {
+                    "@": path.resolve(__dirname, "./src"),
+                    },
+                }`
+        )
+        fs.writeFileSync(viteConfigPath,finalCont)
+
+        await execa("npx",["shadcn@latest", "init","--yes"],{
+            cwd:frontPath,
+            stdio:"inherit"
+        })
+        
+        await execa("npx",[ "shadcn@latest" ,"add" ,"button"],{
+            cwd:frontPath,
+            stdio:"inherit"
+        })
+        fs.writeFileSync(path.join(frontPath,"src/App.jsx"),`import { Button } from "@/components/ui/button"
+
+function App() {
+  return (
+    <div className="flex min-h-svh flex-col items-center justify-center">
+      <h1>This botton is created from shadcn</h1>
+      <h2>vite ,tailwind and shadcn are setted now just go and enjoy coding</h2>
+      <Button>Click me</Button>
+    </div>
+  )
+}
+
+export default App`)
+
+    
+        
+           
+    } catch (error) {
+        console.log(error);
+        
+    }
+}

package/src/generator/setupTailwind.generator.js

@@ -0,0 +1,45 @@
+import { execa } from "execa"
+import fs from "fs"
+import path from "path"
+
+export const setupTailwind=async(frontPath)=>{
+    try {
+        await execa("npm",["install", "tailwindcss", "@tailwindcss/vite"],{
+            cwd:frontPath,
+            stdio:"inherit"
+        })
+
+        const cssFile= path.join(frontPath,"src/index.css")
+        const updatedCssCont=`@import "tailwindcss";`
+        fs.writeFileSync(cssFile,updatedCssCont)
+
+        console.log("css updated");
+        
+
+
+        const htmlFile= path.join(frontPath,"index.html")
+        const htmlContent= fs.readFileSync(htmlFile,'utf8')
+        
+        const updatedHtmlCont= htmlContent.replace(/<\/title>\s*/i,`</title> \n \t <link href="/src/style.css" rel="stylesheet"> \n`)
+        // console.log(updatedHtmlCont);
+        fs.writeFileSync(htmlFile,updatedHtmlCont)
+
+        console.log("html updated \n \n");
+        
+        
+        const configFile= path.join(frontPath,"vite.config.js")
+        const configCont= fs.readFileSync(configFile,'utf8')
+        const updatedConfigCont= configCont.replace(/plugins: \[\s*/,`plugins: [tailwindcss(),`)
+        fs.writeFileSync(configFile,`import tailwindcss from '@tailwindcss/vite' \n`+updatedConfigCont)
+        // console.log(updatedConfigCont);
+
+        console.log("pluggin updated \n \n");
+        
+
+
+        
+    } catch (error) {
+        console.log(error);
+        
+    }
+}

package/src/generator/setupVite.generator.js

@@ -0,0 +1,51 @@
+import { execa } from "execa";
+
+export const setupVite=async(frontPath)=>{
+    try {
+         const proc=execa("npm",["create","vite@latest",".","--","--template","react"],{
+                    cwd:frontPath,
+                    stdio: ["pipe", "inherit", "inherit"]})
+         proc.stdin.write("n\n")
+        await proc;
+    } catch (error) {
+        console.log(error);
+        
+    }
+}
+// import { execa } from "execa";
+
+// export const setupVite=async(frontPath)=>{
+//     try {
+//             const proc=execa("npm",["create","vite@latest","."],{
+//                     cwd:frontPath,
+//                     stdio: ["pipe","pipe","inherit"]
+//                 })
+//             proc.stdout.on("data",(data)=>{
+//                 const text=data.toString()
+//                 console.log(text);
+//                 if(text.includes("Select a framework"))
+//                 {
+//                     proc.stdin.write("\x1B[C\x1B[C\n")
+//                 }
+//                 else if(text.includes("Select a variant"))
+//                 {
+//                     proc.stdin.write("\x1B[C\x1B[C\x1B[C\n")
+//                 }
+//                 else
+//                 {
+//                     proc.stdin.write("n\n")
+//                 }
+                
+//             })
+//             await proc;
+
+
+        
+        
+//     } catch (error) {
+//         console.log(error);
+        
+//     }
+// }
+
+

package/src/generator/structure.generator.js

@@ -0,0 +1,101 @@
+import chalk from 'chalk';
+import fs from 'fs'
+import path from 'path';
+import { exit } from 'process';
+
+import { frontendSetup } from '../setups/frontend.setups.js';
+import { backendSetup } from '../setups/backend.setup.js';
+import { execa } from 'execa';
+
+
+export const createProjectStructure=async(answer)=>{
+    try {
+        let dirPath=''
+        if (answer.currentFolder){
+            dirPath= process.cwd()
+            console.log(dirPath);
+            
+            await frontentFolder(dirPath,answer);
+        
+            await backendFolder(dirPath,answer);
+        }
+        else
+        {
+            dirPath=  path.join(process.cwd(),answer.ProjectName)       //  main_dir path
+            // console.log(dirPath);
+            
+            await ProjectFolder(answer.ProjectName)                         //  main_dir created
+            console.log("folder created successfully");
+    
+            await frontentFolder(dirPath,answer);
+            
+            await backendFolder(dirPath,answer);
+
+        }
+        console.log(`
+            api calls - use 
+            ->  axiosInstance
+            now in one terminal got to 
+            ->  ${dirPath}/frontend 
+                run 
+            ->  npm run dev
+                in next terminal go to 
+            ->${dirPath}/backend 
+                run 
+            ->  npm run dev`);
+        
+        
+        
+        
+    } catch (error) {
+        console.log(error);
+        
+    }
+}
+
+const ProjectFolder=async(name)=>{
+    try {
+        
+        if(fs.existsSync(name))
+        {
+            console.log(chalk.red("folder already exist"));
+            process.exit(1)
+             
+        }
+        else
+            fs.mkdirSync(name)
+    } catch (error) {
+        console.log(error);
+        
+    }
+}
+const frontentFolder=async(dirPath,answer)=>{
+    try {
+        fs.mkdirSync(path.join(dirPath,"frontend"))
+        const frontPath=path.join(dirPath,"frontend")
+        
+        await frontendSetup(frontPath)
+
+    } catch (error) {
+        console.log(error);
+        
+    }
+}
+const backendFolder=async(dirPath,answer)=>{
+    try {
+        fs.mkdirSync(path.join(dirPath,"backend"))
+        fs.mkdirSync(path.join(dirPath,"backend/src"))
+        const backPath=path.join(dirPath,"backend")
+        
+        await execa("npm",["init","-y"],{
+            cwd:backPath,
+            stdio:"inherit"
+        })
+        await backendSetup(backPath,answer)
+        
+
+    } catch (error) {
+        console.log(error);
+        
+    }
+}

package/src/prompts/question.prompt.js

@@ -0,0 +1,54 @@
+import chalk from "chalk";
+import inquirer from "inquirer";
+
+
+export const askQuestions=async()=>{
+    try {
+        console.log(chalk.red("Project Details"));
+        console.log(chalk.white("------------------"));
+        const answer=await inquirer.prompt([
+        {
+            type:"confirm",
+            name:"currentFolder",
+            message:"use current folder as the project folder or create new one(yes/no)?",
+            
+        },
+        {
+            type:"input",
+            name:"ProjectName",
+            message:"If no Enter the project Name :",
+            when:(answer)=>!answer.currentFolder,
+            validate:(value)=>{
+                if (!value)
+                {
+                    value=null
+                    return "Cannot leave Empty"
+                }
+                return true
+                
+            }
+        },
+        {
+            type:"input",
+            name:"mongoURL",
+            message:"Enter the mongoDB url (double check before pasting)",
+            validate:(value)=>{
+                if (!value)
+                {
+                    value=null
+                    return "Cannot leave Empty"
+                }
+                return true
+                
+            }
+        }
+    ])
+    console.log(answer);
+    
+    return answer;
+    } catch (error) {
+        console.log(error.message);
+        
+        
+    }
+}

package/src/setups/backend.setup.js

@@ -0,0 +1,15 @@
+import { setupAxios } from "../generator/setupAxios.generator.js";
+import { setupDotEnv } from "../generator/setupDotEnv.generator.js";
+import { setupExpress } from "../generator/setupExpress.generator.js";
+import { setupMongo } from "../generator/setupMongo.generator.js";
+
+export const backendSetup=async(backPath,answer)=>{
+    try {
+        await setupExpress(backPath)
+        await setupMongo(backPath,answer)
+        await setupDotEnv(backPath,answer)
+    } catch (error) {
+        console.log(error);
+        
+    }
+}

package/src/setups/frontend.setups.js

@@ -0,0 +1,19 @@
+import { execa } from "execa"
+import { setupVite } from "../generator/setupVite.generator.js";
+import { setupTailwind } from "../generator/setupTailwind.generator.js";
+import { setupShadCN } from "../generator/setupShadCN.generator.js";
+import { setupAxios } from "../generator/setupAxios.generator.js";
+
+export const frontendSetup=async(frontPath)=>{
+    try {
+
+        await setupVite(frontPath)
+        await setupTailwind(frontPath)
+        await setupShadCN(frontPath)
+        await setupAxios(frontPath)
+        
+    } catch (error) {
+        console.log(error);
+        
+    }
+}