Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.64 KB

README.md

File metadata and controls

39 lines (28 loc) · 1.64 KB

gov.uk webpage templating and rendering

This repo is a framework for creating consistent webpages for use with UK Government websites. It is based on the GDS prototyping kit (and uses nunjucks for templating) but allows more flexibility. It assumes you require the pages output as flat HTML/CSS/JS to be used with whatever backend you are using for production - there is no direct nodejs support/running.

This includes the styles taken from Gov UK Frontend Toolkit and sass from govuk-elements-sass

Table of contents

  1. Requirements
  2. Setup
  3. Run
  4. Developer notes

Requirements

This repo requires you to have NodeJS installed (version 4.x.x or higher).

NodeJs & NPM

Setup

  • $ cd <your_project_folder
  • $ npm install

Run

  • Run $ gulp dev
  • A window will automatically open on http://localhost:8000 on the page specified in the gulpfile.js file
  • the built flat pages will be in the 'build' folder
  • specify other grunt targets to build for production (for instance with minification and so on) as needed by your project

##Developer notes

  • uses mockjax to do stubbed responses to ajax requests
  • appconfig.js specifies different endpoints for ajax requests - edit as required by your environments and point to the relevant endpoint by setting up an appropriate Grunt 'replace' task
  • Chimp has been included to do automated running of unit tests (jasmine) and cucumber