/vulcanjs-cli

The official cli scaffolding tool for VulcanJS

Primary LanguageJavaScript


vulcanjs-banner
VulcanJS-cli

The official CLI scaffolding tool for VulcanJS.

Warning

This tool is very new and is still under development. Use with caution. Always commit your code before using any program that modifies it.

Table of Contents

Background

VulcanJS is a full stack javascript framework, built on Meteor, React and GraphQL. If you aren't familiar with VulcanJS, we highly recommend that you check out the website and read the docs.

With this cli, you'll be able to easily generate packages, models, components, and routes for your VulcanJS project.

Install

Npm:

$ npm install -g vulcanjs-cli

Yarn:

$ yarn global add vulcanjs-cli

Usage

Create

Creates a new project with the given app name:

$ vulcan create <appName>

Generate

Generates a project component

  • Generate Package
$ vulcan g package <packageName>
  • Generate Model
$ vulcan g model <packageName> <modelName>
  • Generate Component
$ vulcan g component <packageName> <modelName> <componentName>
  • Generate Route
$ vulcan g route <packageName> <routeName> <routePath>

Remove

  • Remove Package
$ vulcan remove package <packageName>
  • Remove Model
$ vulcan remove model <packageName> <modelName>

List

  • List Packages
$ vulcan list packages
  • List Routes
$ vulcan list routes

Maintainers

@mechanical-turk

@albancrommer

@SachaG

Contribute

See CONTRIBUTE.md!

PRs are always welcome.

License

MIT © 2017 Kerem Kazan