Pugin

pugin is a component-based pattern design library created by the Parliamentary Digital Service that holds all of the reusable partials, styles and scripts for elements of the UK Parliament's microservices. It is named after the designer Augustus Welby Northmore Pugin, who provided designs for the interior of the Palace of Westminster.

NOTE: This gem is in active development and is likely to change at short notice. It is not recommended that you use this in any production environment.

Requirements
Installation
Usage
- Example
Getting Started with Development
- Running the tests
Contributing
License

Requirements

pugin requires the following:

Ruby - click here for the exact version
Bundler
Rails
HAML

Installation

Within your rails application, add the below to your Gemfile.

gem 'pugin', '~> 0.2'

Usage

This gem's main function is to expose front-end components and assets to the host application's asset pipeline.

Once you add the gem to your Gemfile run:

bundle install

Now all of the view components should be available within your host application.

Example

<%= render 'pugin/components/status' %>

Getting Started with Development

To clone the repository and set up the dependencies, run the following:

git clone https://github.com/ukparliament/pugin.git
cd pugin
bundle install

Running the tests

We use RSpec as our testing framework and tests can be run using:

bundle exec rake

Contributing

If you wish to submit a bug fix or feature, you can create a pull request and it will be merged pending a code review.

Fork the repository
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Ensure your changes are tested using Rspec
Create a new Pull Request

License

pugin is licensed under the Open Parliament Licence.

katylouise/pugin