Mevn-Cli

A CLI tool for getting started with MEVN stack. It offers a super simple boilerplate project & a reliable boilerplate pwa and additional utilities for building a MEVN app. It helps out, beginner developers to easily create a template for their Web application development.

Getting Started

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

Prerequisites

npm - It is the package manager for node.
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:route`	To create the Routes-File(API)
`mevn-cli create:model`	To create the Models-File(SCHEMA)
`mevn-cli create:controller`	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 and a reliable boilerplate pwa 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

Before contributing to this repository, please first discuss the change you wish to make via issue, or any other method with the owners of this repository before making a change.

How do I contribute?

Ensure you have no "dummy" files left, if you do simple add them to the bottom of the .gitignore.
Fork and clone our repository.
Make your life-changing changes.
Commit and push your changes.
Make a detailed pull request.

Why should I contribute?

Contributing helps people and makes the world simply a better place, without contributors this project would cease to exist.

What if I cannot code or do not like it?

You can always write documentation, most repositories lack in it.

What is next?

Nothing! Your done and ready to get coding!

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.

Bazooo/mevn-cli