momohyusuf / mern-scaffold

A CLI tool that helps you easily generate boilerplate code for MERN application.

MERN SCAFFOLD

mern-scaffold is a CLI tool that helps you to quickly develop basic boilerplate code for your MERN app. You can generate boilerplate code for your Frontend or Backend. You can also generate them as a full stack project.

Installation

By using npm (the recommended way):

npm install -g mern-scaffold

mern-scaffold will be installed globally to your system path.

Usage

After downloading, on you Command line just type

mern-scaffold

Frontend app

The frontend uses vite-plugin-react-swc []

Speed up your Vite dev server with SWC

• ✅ A fast Fast Refresh (~20x faster than Babel)
• ✅ Enable automatic JSX runtime

The following folders and files will be generated

- 📂 layouts
- 📂 pages
- 📂 public
- 📂 src
- 📄 .env
- 📄 .eslintrc.cjs
- 📄 .gitignore
- 📄 index.html
- 📄 package.json
- 📄 postcss.config.js
- 📄 README.MD
- 📄 tailwind.config.js
- 📄 vite.config.js

Extra default packages

The frontend also comes with the following default packages installed:

• Tailwindcss TailwindCSS
• React router dom React router
• Validator validator
• Axios axios

Component library

You can select a component library to add The two options presently supported are

• Ant Design antd
• Material UI MUI

The Backend

The backend contains basic boilerplate code for an express app

The following folders and files will be generated

- 📂 config
- 📂 controllers
- 📂 middleware
- 📂 model
- 📂 routes
- 📂 utils
- 📂 public
- 📄 .env
- 📄 .gitignore
- 📄 index.js
- 📄 package.json
- 📄 README.MD

The backed also comes with the following default dependencies installed:

• Bcrypt bcrypt
• Cors cors
• Dotenv React router
• Express express
• Express async Errors express-async-errors
• Json web token jsonwebtoken
• Mongoose mongoose
• Morgan morgan
• Validator validator

Full-stack

This consist of:

• Everything in frontend
• Everything in Backend

Starting Application

After The respected folders has been generated run

cd folder_name
npm install
npm run dev

support

If you would like to support me, you can buy me a coffee ☕