Muxu CLI

Muxu CLI is command line tool that help to perform actions for Muxu SSR framework.

Get Started

First, install Muxu CLI globally :

Using Yarn :

yarn global add muxu-cli

Using NPM :

npm install muxu-cli --global

Now you can check the installation by running the command :

muxu --version 

# You should get an output like "vX.X.X"

Commands

New Project

To create a new Muxu project, you can run the following command :

muxu new [project-name]

Version

Check your CLI version with :

muxu -v, --version

Contributing

Everyone can contribute to Muxu project. To add a feature or to fix a bug, please follow contributing behavior.

Code of conduct

Muxu has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Add a new feature

1. Fork the repository
2. Create a new branch from develop with the following semantic feature/[feature-name]
3. Work on your helpful idea and implement test if needed
4. Check if there no regression by running yarn test
5. Make a pull request that target the develop branch

Fix a bug on develop (Not in production yet)

1. Fork the repository
2. Create a new branch from develop with the following semantic feature/bugfix-[bugfix-name]
3. Work on your helpful bug fix and improve test if needed
4. Check if there is no regression by running tests with yarn test
5. Make a pull request that target the master branch

Fix a bug on master

1. Fork the repository
2. Create a new branch from master with the following semantic bugfix/[bugfix-name]
3. Work on your helpful bug fix and improve test if needed
4. Check if there is no regression by running tests with yarn test
5. Make a pull request that target the master branch

License

Muxu is MIT licensed.