@muil/viewer

Visit Muil Docs.

Automate Installation

Get started using the automatic command line tool. This command installs and adds everything you need to get start with Muil.

Inside your root directory run:

npx -p @muil/cli muil-cli init

Manual Installation

To get start with Muil you will need:

1. Run this line inside you root directory:

npm install --dev @muil/viewer

or

yarn add --dev @muil/viewer

1. Add these scripts to package.json:

 "scripts": {
    ...
    "muil": "muil-viewer",
    "muil-cli": "muil-cli"
  },

1. Add templates folder in your root directory

root directory
├───src
│   ├───components
│   │   ├───Component1.js
│   │   ├───Component2.js
│   │   └───Component3.js
└───templates
    ├───Template1.js
    ├───Template2.js
    └───Template3.js

Usage

To start muil viewer run:

yarn muil

or

npm run muil

To use options with npm run npm run muil -- <args>. See here

Viewer Options

Usage: muil [options]

Options:
  -p --port <port>                              Viewer port (default: 8000)
  -d --templatesDirectory <templatesDirectory>  Templates root directory (default: "./templates")
  -h, --help                                    output usage information