initiate-mern

Simple MERN scaffolder to quickly bootstrap a full-stack MongoDB, Express, React, and Node.js project.

Features

• Generates a ready-to-run MERN stack project
• Backend: Express, MongoDB (Mongoose), CORS, dotenv, cookie-parser, method-override
• Backend includes scaffolded models and utils directories (e.g., models/User.js, utils/logger.js)
• Frontend: React (Vite), React Router, Axios
• Frontend comes with Tailwind CSS preconfigured (tailwind.config.js, postcss.config.js, and ready-to-use styles)
• Sample API route and page integration
• Environment variable templates for both backend and frontend

Getting Started

1. Install

Clone this repository and install dependencies:

npm install

Or install globally from npm (after publishing):

npm install -g initiate-mern-cli

2. Usage

Directly run the CLI to initiate a new MERN project:

npx initiate-mern

You will be prompted for:

• Project name
• MongoDB database name
• Backend port
• Frontend port

A new folder with your project will be created.

3. Running the Project

Backend

cd <your-project-name>/backend
npm run dev

Frontend

cd <your-project-name>/frontend
npm run dev

Note: Tailwind CSS is preconfigured in the frontend. See tailwind.config.js and postcss.config.js in the frontend root.

4. Environment Variables

• Copy .env.example to .env in both backend and frontend/src folders and adjust as needed.

Project Structure

backend/
  .env.example
  server.js
  config/
    db.js
  controllers/
    sampleController.js
  middlewares/
    errorHandler.js
  models/
    User.js
  utils/
    logger.js
  public/
    index.html
  routes/
    index.js
frontend/
  src/
    .env.example
    App.jsx
    main.jsx
    pages/
      AboutPage.jsx
      HomePage.jsx
    services/
      api.js
  postcss.config.js
  tailwind.config.js

License

This project is licensed under the MIT License.