The official cli scaffolding tool for VulcanJS
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist
media
src
test
.gitignore
CONTRIBUTE.md
Gruntfile.js
README.md
package-lock.json
package.json
yarn.lock

README.md


vulcanjs-banner
VulcanJS-cli

The official CLI scaffolding tool for VulcanJS.

Warning

This project is young. Use with caution. Always commit your code before using any program that modifies it.

Last tested on Vulcan 1.12.

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, modules, 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 Module
$ vulcan g module <packageName> <moduleName>
  • Generate Component
$ vulcan g component <packageName> <moduleName> <componentName>
  • Generate Route
$ vulcan g route <packageName> <routeName> <routePath>

Remove

  • Remove Package
$ vulcan remove package <packageName>
  • Remove Module
$ vulcan remove module <packageName> <moduleName>

List

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

Maintainers

@mechanical-turk

@albancrommer

@SachaG

@eric-burel

Contribute

See CONTRIBUTE.md!

This package is in very low maintenance mode. If you encounter a bug or have a suggestion, feel free to open an issue, but we won't guarantee any fix.

PRs are always welcome however, even if incomplete or just a draft.

License

MIT © 2017 Kerem Kazan