README.md

Router API

Router API provides an API for updating the routes used by Router.

Technical documentation

This is a Ruby on Rails app, and should follow our Rails app conventions.

You can use the GOV.UK Docker environment to run the application and its tests with all the necessary dependencies. Follow the usage instructions to get started.

Run the test suite

If you are not using govuk-docker, you will need a MongoDB instance running at $TEST_MONGODB_URI (which defaults to localhost) to run some of the tests.

bundle exec rake

Further documentation

• API Endpoints

Team

GOV.UK Platform Engineering team looks after this repo. If you're inside GDS, you can find us in #govuk-platform-engineering or view our kanban board.

Licence

MIT License