Parliament.uk-things

Parliament.uk-things is a Rails application designed to hold the individual 'thing' elements of the new parliament.uk website made by the Parliamentary Digital Service.

Contents

• Requirements
• Getting Started
• Things Rails Application
  • Running the application
  • Running the tests
• Contributing
• License

Requirements

Parliament.uk-things requires the following:

• Ruby
• Bundler

Getting Started

Clone the repository:

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

Things Rails Application

The Parliament.uk-things application holds the routes, controllers and views that make up all the 'thing' elements of the new parliament.uk website. 'Things' are singular, individual items with ids.

Running the application

To run the application locally, run:

bundle install

bundle exec rails s

Running the tests

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

bundle exec rspec

Maps

Our maps use the leafletjs library that is published under the 2-clause BSD License.

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 Rspec
6. Create a new Pull Request

License

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