itsVagabond / mevn-cli

A cli tool for mevn stack

Mevn-Cli

A CLI tool for getting started with MEVN stack. It offers a [super simple boilerplate] (https://github.com/Madlabsinc/mevn-boilerplate) and a reliable boilerplate-pwa for building a MEVN app. It helps out, beginner developers to easily create a template for their Web application development.

TL;DR: Commands Sequence

npm install -g mevn-cli

mevn init your_new_app

cd your_new_app

npm install

npm start

If faced some issue, follow the following

Getting Started

Currently, this tool works on the Windows and Linux platform.

Prerequisites

• Npm - it is a package manager for the JavaScript programming language.
• Node.js -Node.js is an open-source, cross-platform JavaScript run-time environment that executes JavaScript code outside of a browser.
• Git - Git is a version control system for tracking changes in computer files and coordinating work on those files among multiple people. It is primarily used for source code management in software development.

Installing

To install the package:-

npm install -g mevn-cli

Commands

Initial Command

This command Initialises the project.

mevn-cli init appname

Server Commands

These commands are used to generate the code necessary for running a server.

command	description
mevn-cli create:routes	To create the Routes-File(API)
mevn-cli create:models	To create the Models-File(SCHEMA)
mevn-cli create:controllers	To create the Controllers-File
mevn-cli create:config	To create the Config-File

General Command

These are commands to run the Client and Server

command	description
mevn-cli run:server	To run the Server
mevn-cli run:client	To run the Client

Features

• This tool provides an easy way to build a web app by providing a super simple boilerplate project to build upon.
• Its written in ES6 syntax, which is a developer-friendly syntax that keeps the code simpler and smaller.
• The whole project is done in modules(thanks to ES6 syntax) which enhances user readability and much more compact code.
• Mevn-Cli will automate the files and generate the codes necessary to start and run a server, API etc

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning And Help

command	description
mevn-cli -v	Check CLI version
mevn-cli --help	Get help and check usage

License

This project is licensed under the MIT License - see the LICENSE.md file for details.