Skip to content
Inside Government: how the UK Government works, what it's doing, and how you can get involved.
Ruby HTML CSS JavaScript Cucumber Shell
Latest commit f0439b1 May 24, 2016 @jackscotti jackscotti Merge pull request #2607 from alphagov/move-env-variables
Move ENV variables to test helper
Failed to load latest commit information.
app Add helper copy to admin attachments interface May 24, 2016
bin Remove spring. Jul 10, 2015
carrierwave-tmp Add explicit carrierwave-tmp dir Aug 23, 2013
config Amend accessibility wording in Whitehall May 19, 2016
db Merge pull request #2601 from alphagov/fix-stats-announcement-redirec… May 20, 2016
docs Remove worldwide priority code. Apr 21, 2016
features Add political and government to DetailedGuide presenter. Apr 29, 2016
lib Merge pull request #2598 from alphagov/run-all-schema-tests May 20, 2016
log Quite literally the initial commit. Sep 19, 2011
public Amended comment from 404 to 403 Mar 16, 2015
script Amend scope name in working group sync check Mar 17, 2016
test Move ENV variables to test helper May 24, 2016
vendor/assets/stylesheets Revert "Revert "Merge pull request #571 from alphagov/rails-upgrade"" Jun 20, 2013
.gitignore Use latest shared_mustache Feb 19, 2015
.ruby-version Upgrade Ruby to 2.2.3 Jan 7, 2016
.yardopts Cope with search bots adding [] to param keys Jul 3, 2013
CONTRIBUTING.md Replace Travis guidance with Jenkins Oct 2, 2015
Gemfile Bump govspeak to 3.6.2 May 9, 2016
Gemfile.lock Bump govspeak to 3.6.2 May 9, 2016
LICENCE Fix the copyright notice Feb 18, 2015
Procfile Add Foreman worker to run Sidekiq Sep 27, 2013
README.md Fix typo in README Apr 12, 2016
Rakefile Bring back basic logging for tests Oct 17, 2014
config.ru Add Raindrops to Rack configuration Oct 22, 2013
convert-tables.sh Remove detailed guide categories from database Aug 7, 2015
jenkins-schema.sh Move ENV variables to test helper May 24, 2016
jenkins.sh Move ENV variables to test helper May 24, 2016
startup.sh Don't override passed in STATIC_DEV env var in startup.sh Aug 13, 2014

README.md

Code Climate

Whitehall App

"Whitehall" is the code name for the Inside Government project, which aims to bring Government departments online in a consistent and user-friendly manner. Documentation can be found on rdoc.

Nomenclature

  • Govspeak A variation of Markdown used throughout 'Whitehall' as the general publishing format

Technical Documentation

Whitehall is a Rails 4 app built on a MySQL database. It is deployed in two modes, 'admin' for publishers to create and manage content and 'frontend' for rendering content under https://www.gov.uk/government. In addition to storing and managing its own content database Whitehall also updates various other APIs including search and is currently being migrated towards a new publishing model utilising Publishing API and Content Store.

Dependencies

  • Xcode (for the Command Line Tools xcode-select --install)
  • Ruby 2.2.3
  • Rubygems and Bundler
  • Mysql
  • Imagemagick and Ghostscript (for generating thumbnails of uploaded PDFs)
  • xpdf (first download XQuartz)
  • PhantomJS (for running the Javascript tests)

Running the application

The application can be started with

bundle exec rails s

Note that the application itself will respond to requests on the root URL / with a routing error. To check that it works, try visiting /government/admin and /government/organisations.

Further setup instructions are available in the detailed setup guide

Running the test suite

See the testing guide

Assets

GOV.UK shares assets (eg stylesheets and JavaScript) across apps using the slimmer gem and the static app.

See the local asset setup guide

Search

The Whitehall app relies on Rummager for document indexing, and the GOV.UK frontend application to serve results.

See the search setup guide

Other guides

Timestamps

Internationalisation

Creating new users

Contributing guide

Generating the documentation

We use YARD for the documentation. You can generate a local copy with:

yard server --reload

You can also read the docs on rdoc.info.

Licence

MIT License

Something went wrong with that request. Please try again.