Create-mern-application NPM

Example of create-mern-application running

📝 Table of Contents

🧐 About

I've made a lot of MERN applications lately, and I want to make that process easier for myself and for others, by creating a bootstrapper that mirrors the simplicity of starting a new application with create-react-app. Thus, create-mern-application was born.

What is MERN?

MongoDB - MongoDB - Database
ExpressJS - ExpressJS - BackEnd
React - React - FrontEnd
Node - Node - Runtime Environment

🏁 Getting Started

Prerequisites

Node (>= v10.13.0)
NPM

OS

MacOS
Linux
Windows

Installing

You can either use npx , or install the package globally on your machine.

NPX

npx create-mern-application cool-app-name

Global Install

npm install -g create-mern-application

🎈 Usage

npx create-mern-application cool-app-name

Changing the Source Language

By deafault, create-mern-application will create your application as a JavaScript project. You can pass the --typescript flag to create a TypeScript project instead.

create-mern-application cool-app-name --typescript

Want support for an additional language? Feel free to open a new issue.

Interactive Mode

You can choose to use the application in an interactive mode by passing the flag --interactive.

This mode grants you several additional options.

Starting the Application

Please be sure to have your MongoDB instance running prior to starting your application.

npm start

⛏️ Built Using

Dependencies

@sentry/node - Sentry is cross-platform application monitoring, with a focus on error reporting.
chalk - Terminal string styling done right.
commander - Node.js command-line interfaces made easy.
fs-extra - Node.js: extra methods for the fs object like copy(), remove(), mkdirs().
inquirer - A collection of common interactive command line user interfaces.
ora - Elegant terminal spinner.
recursive-readdir - Node.js module to list all files in a directory or any subdirectories.
semver - The semver parser for node (the one npm uses).
update-notifier - Update notifications for your CLI app.
validate-npm-package-name - Is the given string an acceptable npm package name?

DevDependencies

@babel/plugin-transform-runtime - 🐠 Babel is a compiler for writing next generation JavaScript.
@babel/preset-env - 🐠 Babel is a compiler for writing next generation JavaScript.
copyfiles - Copy files on the command line.
jest - Delightful JavaScript Testing.
prettier - Prettier is an opinionated code formatter.
typescript - A typed superset of JavaScript that compiles to plain JavaScript.