scriptonist / mevn-cli Goto Github PK

Light speed setup for MEVN stack based web-apps

Chat: Telegram

Donate: PayPal, Open Collective, Patreon

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.

• Basic
• Pwa
• GraphQL
• Nuxt.js

• npm 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:-

• It allows Developers to build webapps with ease in which all the local environment setup is being taken care of. All they have to do is to focus on writing actual code.
• It uses ES6 syntax, which is developer-friendly and keeps the code simpler and smaller.
• The whole project is done in modules(thanks to ES6 syntax) which enhances user readability and leads to compact code.
• MEVN-CLI simplifies developer workflow by generating boilerplate code as required and automating redundant tasks.

Before contributing a change to this repository, please first discuss the change you wish to make via issue, or any other method with the owners of this repository . Take a look at the Contributing Guidelines to get a better picture regarding the codebase and project structure.

1. Ensure you have no "dummy" files left, if you do then add them to the bottom of .gitignore.
2. Fork and clone our repository.
3. Make your life-changing changes.
4. Run npm run build which generates a lib directory with the transpiled es5 code.
5. Fire in sudo npm link to test everything works fine.
6. Commit and push your changes.
7. Make a detailed pull request.

npm link creates a symlink in the global folder making the mevn command globally available within your local development environment

Contributing helps people and simply makes the world 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 optional

Following that pattern, your commit messages should look like these:

feat: activate open collective

chore: 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 #123

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

Nothing! You're done and ready to get coding!

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.