zoomcar/zcui

CLI to generate vue projects with option to create components/layout/pages etc.

Getting started

Prerequisites

Node

First, install the latest version of Node.

Node is available for a variety of platforms at nodejs.org. It is important that you not install Node with sudo in order to avoid permission problems. On Unix, nvm provides a convenient way to do this. On OS X, you can also use Homebrew. On Windows, chocolatey is an option.

After the installation is complete, verify that Node is set up correctly by typing the below commands on the command line. Both should output a version number:

$ node -v
$ npm -v

zcui CLI

Once you’ve installed Node, you’ll need to globally install zcui CLI:

$ npm install -g zcui

After the installation is complete, verify that zcui is set up correctly by typing the below command on the command line.

$ zcui --version

---

Common commands

$ zcui
#------
  # Commands:
    new <app-name>      # Initialize new app                           [aliases: n, init]
    create <type>       # Create new component/page/layout etc  [aliases: generate, c, g]

  # Examples:
    zcui new HelloWorld
    zcui create component Calendar


$ zcui new <app>
#------------------
  # Options:
    --target, -t   # target template name       [string] [required] [choices: "vue"]

  # Examples:
    zcui new HelloWorld --target vue


$ zcui create <type>
#---------------------
  # Commands:
    component <name>  # create new component
    layout <name>     # create new layout
    page <name>       # create new page
    helper <name>     # create new helper
    store <name>      # create new store module
    style <name>      # create new Style partial

  # Examples:
    zcui create component Calendar
    zcui create layout Default
    zcui create page Home --layout Default
    zcui create helper date
    zcui create store user
    zcui create style button

---

Support Variants / Targets

• vue
• vue-pwa