Skip to content
/ viewer Public

Muil is a framework to build, maintain and manage dynamic templates using React and tools you know and love

License

Notifications You must be signed in to change notification settings

muil-io/viewer

Repository files navigation

Installation

Automatic setup

Run inside the directory:

npx -p @muil/cli muil-cli init

Manual setup

Run inside the directory:

npm install --dev @muil/viewer or yarn add --dev @muil/viewer

Add to package.json:

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

Add templates:

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

Usage

Run viewer with npm run muil or yarn muil to edit your email.

-p --port Viewer port, default: 8000
-d --templatesDirectory Templates root directory, default: './templates'

Cli

  • Login - yarn muil-cli login - login to muil service

    -u --user username
    -p --password password
    
  • Logout - yarn muil-cli logout - logout from muil service

  • Publish - yarn muil-cli publish - build templates and upload to muil

    -d --templatesDirectory templates root directory, default: './templates'
    -b --branch templates branch, default: master
    
  • Unpublish - yarn muil-cli unpublish - clean branch

    -b --branch templates branch, default: master
    

About

Muil is a framework to build, maintain and manage dynamic templates using React and tools you know and love

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published