First of all, Thank you for showing an interest in
Mevn-CLI. This page walks you through all the necessary local development setup required if you are contributing to the codebase as well as the Docs.
Local Development setup
The very first step to carry out is to have the repository cloned to your local machine.
- Fork and clone the
- Open up your terminal and navigate to the
- Add the remote upstream repository with
git remote add upstream https://github.com/madlabsinc/mevn-cli.
- Follow a rebase strategy to update your local branch with the latest changes happened in the upstream repository.
- Install the dependencies with
- Now run
npm run buildby which
babeltranspile the existing
es5that can be found within a
- Fire in
npm linkwhich creates a symlink by which you can access
mevnglobally from the terminal.
- Now you can start working on your favorite feature
Contributing helps people and makes the world simply a better place, without contributors this project would cease to exist.
es2015 standards such as arrow functions.
We use commander.js as the argument parser. The entire source lies within the
src directory. You can find a
mevn.js file within the
bin directory where the configuration
for the entire tool resides. Just spend some time familiarising yourself with this file as it would give you an idea about the entire project hierarchy where all action handlers are brought about and invoked.
It creates a
mevn.json file within the newly bootstrapped directory holding useful information such as the
Mevn-CLI offers dedicated commands to deal with both the client and server-side of the boilerplate template. When it comes to the Front End part Developers have the provision to create new components with ease or add his favorite dependency on the go without leaving the terminal. All he has to do is type in the respective command, sit back and relax while the dependencies get installed if that's the case. If you have worked on Vue.js before you may remember the pain that you faced while adding vuetify to your existing project or providing support state management with the vuex store.
For the server-side part,
Mevn-CLI provides out of the box support for the MVC (Model-View-Controller) architecture where in which one can create the model, controller, and DB configuration files with ease. The user will be presented with all the 4 basic CRUD operations on top of which he can build upon. Deploy your web-app to any of the cloud hosting solution as you wish (only supports Heroku as per now). All required from your side is to fire in the respective command and see the magic The tool automatically creates a production build your application will be live in a while.
Action handlers (Method to be invoked on firing in the respective command)can be found within
src/commands directory relative to the root repository. We follow a file naming convention that is self-explanatory for the action handlers. For instance, you can find
package.js which contains the action handler for