README
Yeoman generator for Thelma components
Introduction
Thelma web components are built using the Polymer library. The project allows developers to retrieve, manipulate and visualize data by chaining these components together.
generator-thelma provides Thelma component scaffolding using Yeoman (a scaffolding tool for the web), letting you easily create and customize Thelma (custom) elements via the command-line and import them using HTML Imports. This saves you time writing boilerplate code so you can start writing up the logic to your components straight away.
Features
- Sub-generator to create Thelma elements for your app
- Quick deploy to GitHub pages
Installation
Install the generator
npm install -g generator-thelma
Make a new directory and cd into it
mkdir -p my-project && cd $_
Generate a new Thelma component:
yo thelma:seed [element-name]
Generators
Available generators:
Lenses
Generates the Lens Composer and the components that can be used with Lenses. Coming soon.
Seed
Generates a reusable Thelma element.
The seed-element generator will construct a new element and its directory for you. Be aware: all bower dependencies will be installed as siblings of the newly generated element. Make sure that you generate the seed element within a directory that is intended to contain multiple components!
Example:
mkdir -p components && cd $_
yo thelma:seed my-element
Gh
Generates a Github pages branch for your seed-element.
Example:
cd components/my-element
yo thelma:gh
Contribute
See the contributing docs
When submitting an issue, please follow the guidelines. Especially important is to make sure Yeoman is up-to-date, and providing the command or commands that cause the issue.