Skip to content
This repository has been archived by the owner on Dec 17, 2024. It is now read-only.

Commit

Permalink
Tidy up top-level README.
Browse files Browse the repository at this point in the history
Fix the instructions for running the tests so that they don't assume
govuk-docker (which is a disproportionate effort to set up for casual
contributors), plus some minor formatting and style fixes.
  • Loading branch information
sengi committed Oct 17, 2023
1 parent ee77c52 commit 10eff36
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,20 @@ Router API provides an API for updating the routes used by

## 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).
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.
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.

**Use GOV.UK Docker to run any commands that follow.**
### Run the test suite

### Running 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
```

Expand Down

0 comments on commit 10eff36

Please sign in to comment.