Skip to content

alphagov-mirror/manuals-frontend

 
 

Repository files navigation

Manuals Frontend

Purpose

Front-end app for the manuals format on GOV.UK

Nomenclature

Live examples

Dependencies

Installation and running

In a terminal, run:

./startup.sh

or using bowler:

bowl manuals-frontend

If you are using the GDS development virtual machine then the application will be available on the host at http://manuals-frontend.dev.gov.uk/

Running the tests

The test suite includes testing against govuk-content-schemas, so you will need a copy of this repo on your file system. By default this should be in a sibling directory to your project. Alternatively, you can specify their location with the GOVUK_CONTENT_SCHEMAS_PATH environment variable.

All tests can be run using bundle exec rake as well.

Viewing a manual

You can see the content design manual at http://manuals-frontend.dev.gov.uk/guidance/content-design

Publishing a manual on dev

Manuals are published using manuals-publisher to publish a manual run manuals-publisher (instructions here: https://github.com/alphagov/manuals-publisher), publish a manual, and you should then be able to view it on manuals-frontend. If you have replicated from preview recently then you should be able to see currently published manuals at http://manuals-frontend.dev.gov.uk/[preview-slug] too.

Packages

No packages published

Languages

  • Ruby 76.4%
  • HTML 16.2%
  • SCSS 5.9%
  • Other 1.5%