Whitehall is deployed in two modes:
Live examples (public facing APIs)
Live examples (public facing frontend)
CSV Previews
Running the Application
Use GOV.UK Docker to run any commands that follow.
Traditionally, the two sides of Whitehall are available on different domains in development, which reflect their counterparts in production:
While this usually results in different routing behaviour, in development all routes can be accessed from either domain, although the redirect behaviour may differ.
Nomenclature
-
Govspeak A variation of Markdown used throughout whitehall as the general publishing format
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.
Running the test suite
These commands assume you have the GOV.UK Docker environment running and its binaries in your PATH.
# run all the test suites
govuk-docker-run bundle exec rake
Javascript unit tests can also be run separately:
# run all the JavaScript tests
govuk-docker-run bundle exec rake jasmine
Further documentation
See the docs/ directory.
Licence
MIT License