https://github.com/alphagov/router-api
API for updating the routes used by the router on GOV.UK
https://github.com/alphagov/router-api
container govuk
Last synced: 8 months ago
JSON representation
API for updating the routes used by the router on GOV.UK
- Host: GitHub
- URL: https://github.com/alphagov/router-api
- Owner: alphagov
- License: mit
- Archived: true
- Created: 2013-10-14T12:28:04.000Z (about 12 years ago)
- Default Branch: main
- Last Pushed: 2024-12-17T11:09:39.000Z (about 1 year ago)
- Last Synced: 2025-05-08T22:52:25.043Z (8 months ago)
- Topics: container, govuk
- Language: Ruby
- Homepage: https://docs.publishing.service.gov.uk/repos/router-api.html
- Size: 1.19 MB
- Stars: 12
- Watchers: 62
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Router API
Router API provides an API for updating the routes used by
[Router](https://github.com/alphagov/router/).
## Technical documentation
This is a Ruby on Rails app, and should follow [our Rails app
conventions](https://docs.publishing.service.gov.uk/manual/conventions-for-rails-applications.html).
You can use the [GOV.UK Docker
environment](https://github.com/alphagov/govuk-docker) to run the application
and its tests with all the necessary dependencies. Follow [the usage
instructions](https://github.com/alphagov/govuk-docker#usage) 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.
```sh
bundle exec rake
```
## Further documentation
- [API Endpoints](docs/api-endpoints.md)
## Team
[GOV.UK Platform
Engineering](https://github.com/orgs/alphagov/teams/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](https://trello.com/b/u4FCzm53/).
## Licence
[MIT License](LICENCE)
[#govuk-platform-engineering]: https://gds.slack.com/channels/govuk-platform-engineering