A CLI tool for getting started with MEVN stack. It offers various reliable boilerplates as given below and additional utilities for building a MEVN app. It helps out, beginner developers to easily create a template for their Web application development.
Currently, this tool works on the Windows and Linux platform.
- 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.
To install the package:-
npm install -g mevn-cli
This command Initialises the project.
mevn init <app_name>
These are the various commands available for use.
| command | description |
|---|---|
mevn run:server |
To run the Server |
mevn run:client |
To run the Client |
mevn add:package |
To add additional packages as required |
mevn generate |
To generate model, route, controller, and DB config files |
mevn create:component <component_name> |
To create new components as required |
mevn codesplit <component_name> |
Lazy load components as required |
mevn create:git-repo |
To create a GitHub repository and fire the first commit |
mevn dockerize |
To run the client and server in separate docker containers |
mevn deploy |
To deploy the app to Heroku |
- 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
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. Kindly have a look at the Contributing Guidelines to know more regarding the codebase and project structure.
- 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.
- Fire in
sudo npm linkto test everything works fine. - Commit and push your changes.
- Make a detailed pull request.
npm linkcreates a symlink in the global folder makingmevncommand globally available within your local developmet environment
Contributing helps people and makes the world simply a better place, without contributors this project would cease to exist.
You can always write documentation, most repositories lack in it.
Nothing! You're done and ready to get coding!
| command | description |
|---|---|
mevn version |
Check CLI version |
mevn --help |
Get help and check usage |
This project is licensed under the MIT License - see the LICENSE.md file for details.