A CLI tool for getting started with the MEVN stack. The acronym “MEVN” stands for “MongoDB Express.js VueJS Node.js”. It offers a super simple boilerplate template and additional utilities for building a MEVN stack based webapp. It takes away the hassle of setting up the local development environment which may become a nightmare especially for beginners who are just starting out.
- npm it is a package manager for the JavaScript programming language.
- node.js is an open-source, cross-platform JavaScript run-time environment that executes JavaScript code outside of a browser.
- 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.
npm install -g mevn-cli
mevn init <appname>Mevn-CLI offers the following set of commands:-
| command | description |
|---|---|
| mevn init | Bootstraps a MEVN stack based boilerplate template of choice |
| mevn serve | Serves the client/server side template locally |
| mevn add | Adds additional plugins as required on the go |
| mevn generate | Generates component, model, route, controller, and DB config files |
| mevn codesplit | Lazy load components as required |
| mevn dockerize | Serves the client and server in separate docker containers |
| mevn deploy | Deploys the webapp to a cloud service of choice |
| mevn info | Prints debugging information about the local environment |
- It allows Developers to build webapps with ease in which all the local environment setup is being taken care of. All he/she has to do is to focus on writing actual code.
- 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 simplifies the entire workflow by generating boilerplate code as required, automating redundant tasks 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. Take a look at the Contributing Guidelines to get a better picture regarding the codebase and project structure.
- Ensure you have no "dummy" files left, if you do then add them to the bottom of
.gitignore. - Fork and clone our repository.
- Make your life-changing changes.
- Run
npm run buildwhich generates alibdirectory with the transpiledes5code. - 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 making themevncommand globally available within your local development environment
Contributing helps people and makes the world simply a better place, without contributors this project would cease to exist.
This project uses Commitlint to check if the commit messages meet the conventional commit format. The full pattern is:
type(scope?): subject #scope is optional
body? #body is optional
footer? #footer is optionalFollowing that pattern, your commit messages should look like these:
feat: activate open collectivechore: correct typo
It should be "guest" and not "gest"refactor(cli): drop support for node 6
BREAKING CHANGE: you will need to update your node version to keep using this CLI
This closes #123You can always write documentation, most repositories lack in it.
Nothing! You're done and ready to get coding!
| option | description |
|---|---|
| -V, --version | Check CLI version |
| -h, --help | Get help and check usage |
This project exists thanks to all the people who contribute. [Contribute].
Become a financial contributor and help us sustain our community. [Contribute]
Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]
This project is licensed under the MIT License - see the LICENSE.md file for details.