G5 Component Garden

Generates components from static files and provides routes for Gardens.

Current Version

0.2.1

Requirements

Gemfile

Add these lines to your application's Gemfile.

source "https://gems.gemfury.com/88yeKzEGfizstwBaXVqj/"

gem "g5_component_garden"

From Gemfury Command line

Add the Source URL to your .gemrc with this command:

gem sources -a https://gems.gemfury.com/88yeKzEGfizstwBaXVqj/
gem install g5_component_garden

Or use it a single install:

gem install g5_component_garden --source https://gems.gemfury.com/88yeKzEGfizstwBaXVqj/

Usage

Assuming you have the correct file structure, defined over here: https://gist.github.com/d42addbb2550fef37d6e You get these routes and views for free:

components GET /components(.:format)       components#index
 component GET /components/:slug(.:format) components#show
      root     /                           components#index

If you want to do more with the components:

G5ComponentGarden.all #=> Array of G5HentryConsumer::HG5Component
G5ComponentGarden.find("name-of-component") #=> instance of G5HentryConsumer::HG5Component

Authors

Contributing

  1. Fork it
  2. Get it running
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Write your code and specs
  5. Commit your changes (git commit -am 'Add some feature')
  6. Push to the branch (git push origin my-new-feature)
  7. Create new Pull Request

If you find bugs, have feature requests or questions, please file an issue.

Specs

rspec spec

Releases

vi lib/g5_component_garden/version.rb # change version
vi README.md # change version
git add . && git commit -m "bumps version" && git push
git tag -a -m "Version v0.0.0" v0.0.0 && git push --tags
rake build
fury push pkg/g5_component_garden-0.0.0.pkg