jsdelivrbot / boilerplate-grow

Showcase

A repo to house documentation and examples for all our internal components

• Come up with an awesome idea
• Code said idea
• Show it off in this here Showcase

Version

0.2.0

Tech

THe Huge showcase makes use of a number of technologies:

• Grow.io - awesome static site generator
• Rollup - compiles ES6 JS assets

Installation

You will need npm:

$ curl https://install.growsdk.org | bash
$ git clone [email protected]:hugeinc/showcase.git
$ npm install
$ npm run watch
$ grow run

Adding your own Component(s)

Content

First, create a yaml file for your component that will contain various meta-data, description, dates, etc. about your component. Save this in content/components. Feel free to copy / paste an existing file for reference i.e. to see which fields are available, etc.

Template

Next, create the HTML template that will showcase your component. Simply make a <component>.html page in views/components/ that contains documentation and perhaps a demo. It should extend the base component.html template. Again, feel free to copy / paste an existing page.

Deploying

To build and push to hugeinc.github.io/showcase:

$ grow deploy huge

(NOTE: I've deprecated showcase.hugeops.com to avoid any confusion).

TODO

License

MIT