alphagov / government-frontend

Serves government pages on GOV.UK
https://docs.publishing.service.gov.uk/apps/government-frontend.html
MIT License
54 stars 17 forks source link
container govuk govuk-publishing-frontend

Government Frontend

Government Frontend is a public-facing app to display the majority of documents on the /government part of GOV.UK, which are fetched from the Content Store. It is a replacement for the public-facing parts of the Whitehall application.

Schemas

Schema Live example
Answer View on GOV.UK
Case study View on GOV.UK
Consultation View on GOV.UK
Contacts View on GOV.UK
Corporate information page View on GOV.UK
Detailed guide View on GOV.UK
Document collection View on GOV.UK
Fatality notice View on GOV.UK
Fields of operation View on Gov.UK
Field of operation View on GOV.UK
Help page View on GOV.UK
HTML Publication View on GOV.UK
Guide View on GOV.UK
News Article View on GOV.UK
Publication View on GOV.UK
Specialist document View on GOV.UK
Statistics announcement View on GOV.UK
Statistical data set View on GOV.UK
Speech View on GOV.UK
Take part View on GOV.UK
Topical event about page View on GOV.UK
Travel advice View on GOV.UK
Working group View on GOV.UK
Worldwide corporate information page View on GOV.UK
Worldwide office View on GOV.UK
Worldwide organisation View on GOV.UK

Technical documentation

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

You can use the GOV.UK Docker environment or the local startup.sh script to run the app. Read the guidance on local frontend development to find out more about each approach, before you get started.

If you are using GOV.UK Docker, remember to combine it with the commands that follow. See the GOV.UK Docker usage instructions for examples.

Running the test suite

bundle install
yarn install
bundle exec rake

Components

Pages are rendered using components. Components can be specific to government-frontend or shared between applications.

Components specific to government-frontend are within the application and follow rules set out by the govuk_publishing_components gem. They are documented in the government-frontend component guide.

Further documentation

Licence

MIT License