Skip to content

Rohit-Bhardwaj10/Project-setup-cli-tool

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rb-create-app

A powerful CLI tool to quickly scaffold full-stack and backend projects with Express, MongoDB, and modern frontend frameworks.

� Quick Start

Option 1: Use with npx (No Installation Required)

npx rb-create-app

Option 2: Install Globally

npm install -g rb-create-app
create-express-mongo

📖 How to Use

  1. Run the command in your terminal:

    npx rb-create-app
  2. Answer the prompts:

    • Project Name: Enter your project name (e.g., my-awesome-app)
    • Project Type: Choose between:
      • Backend Only - Just the Express server
      • Full-Stack - Backend + Frontend with Vite
    • Backend Language: Choose JavaScript or TypeScript
    • Frontend Framework (if full-stack): Choose React, Vue, or Svelte
  3. Wait for setup: The CLI will:

    • Create your project structure
    • Generate all necessary files
    • Install dependencies automatically
  4. Start developing:

    cd your-project-name
    npm run dev

✨ What You Get

Backend Only

  • ✅ Express.js server (JavaScript or TypeScript)
  • ✅ MongoDB integration ready
  • ✅ Sample routes, controllers, and models
  • ✅ Environment configuration
  • ✅ CORS and middleware setup

Full-Stack

Everything above, plus:

  • ✅ Vite-powered frontend (React/Vue/Svelte)
  • ✅ Pre-configured proxy to backend
  • ✅ Monorepo setup with npm workspaces
  • ✅ Concurrent dev scripts (run both servers at once)

💡 Example Usage

# Create a full-stack TypeScript app with React
npx rb-create-app

✔ Project name: my-app
✔ Project type: Full-Stack
✔ Backend language: TypeScript
✔ Frontend framework: React

# Navigate and start
cd my-app
npm run dev

Your app will be running at:

🧪 Testing Locally (For Developers)

If you're developing this CLI tool:

  1. Clone the repository:

    git clone <your-repo-url>
    cd Project-setup-cli-tool
  2. Install dependencies:

    npm install
  3. Link globally for testing:

    npm link
  4. Test the CLI:

    create-express-mongo
  5. Make changes and test - changes are reflected immediately!

  6. Unlink when done:

    npm unlink -g rb-create-app

� Requirements

  • Node.js 14 or higher
  • npm or yarn

🆘 Troubleshooting

Issue: Command not found after global install
Solution: Make sure npm global bin is in your PATH

Issue: Installation fails
Solution: Try running with administrator/sudo privileges

Issue: Port already in use
Solution: Change the port in the generated .env file

� License

ISC

🤝 Support

Found a bug or have a feature request? Please open an issue on GitHub.


About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published