Parliament.uk-pugin-composition

Parliament.uk-pugin-composition is a Node application designed to provide developers the ability to work with Pugin.

Contents

• Requirements
• Getting Started
• Pugin Composition Application
  • Running the application
  • Running tests
• Contributing
• License

Requirements

Parliament.uk-pugin-composition requires the following:

• Node
• Pug cli

Getting Started

Clone the repository:

git clone https://github.com/ukparliament/Parliament.uk-pugin-composition.git
cd Parliament.uk-pugin-composition

Pugin Composition Application

The Parliament.uk-composition application inherits pugin; the parliament.uk brand, its components and mixins enabling rapid prototyping and consistent branding across Parliamentary projects.

Running the application

To run the application locally, run:

npm install
npm start

Running tests

We run the following tests:

• Pally for Accessibility testing
• Valimate for HTML validation
• Saucelabs for browser/device testing

To run Pally and Valimate:

make test

You can use our automated web testing application Parliament.uk-awt for testing in Saucelabs.

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.

1. Fork the repository
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Ensure your changes are tested using Pally, Valimate and Saucelabs
6. Create a new Pull Request

License

Parliament.uk-pugin-composition is available as open source under the terms of the Open Parliament Licence.