katylouise/parliament.uk-lists

Parliament.uk-lists

Parliament.uk-lists is a Rails application designed to hold the list elements of the new parliament.uk website made by the Parliamentary Digital Service.

Contents

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

Requirements

[Parliament.uk-lists requires the following:

• Ruby
• Bundler

Getting Started

Clone the repository:

git clone https://github.com/ukparliament/parliament.uk-lists.git
cd parliament.uk-lists

Lists Rails Application

The Parliament.uk-lists application holds the routes, controllers and views that make up all the list elements of the new parliament.uk website. A list is anything that can contain more than one item.

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

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][rspec]
6. Create a new Pull Request

License