Skip to content

Latest commit

 

History

History
90 lines (65 loc) · 1.73 KB

README.md

File metadata and controls

90 lines (65 loc) · 1.73 KB
Raw

Aura generator for Yeoman Build Status

=====================================
                             _
      /\                    (_)
     /  \  _   _ _ __ __ _   _ ___
    / /\ \| | | | '__/ _` | | / __|
   / ____ \ |_| | | | (_| |_| \__ \
  /_/    \_\__,_|_|  \__,_(_) |___/
                           _/ |
                          |__/
=====================================

Usage

First make a new directory, and cd into it:

mkdir my-awesome-project && cd $_

Then install generator-aura:

npm install generator-aura

Run yo aura, optionally passing an app name:

yo aura [app-name]

Finally, install npm and bower dependencies:

npm install && bower install --dev

Generators

Available generators:

Aura Component

Generates a component in app/aura_components.

Example:

yo aura:component sample

Produces app/aura_components/sample/main.js

Extension

Generates an extension in app/extensions.

Example:

yo aura:extension storage

Produces app/extensions/storage.js

Styles

Generates cool styles.

Example:

yo aura:styles

Supported types:

  • Default (normalize.css)
  • Twitter Bootstrap
  • Twitter Bootstrap for Compass
  • Zurb Foundation

Contribute

See the contributing docs

License

MIT license