Skip to content
This repository has been archived by the owner on Jun 14, 2019. It is now read-only.

Latest commit

 

History

History
61 lines (42 loc) · 2.81 KB

README.md

File metadata and controls

61 lines (42 loc) · 2.81 KB
Raw

DEPRECATED - Alpha frontend library

⚠️ This repository has been deprecated and is now read only. Please use https://github.com/nhsuk/nhsuk-frontend

GitHub Release Greenkeeper badge Build Status

Version 2 of the frontend library, application non-specific.

This repo has two main purposes:

  • Generate shareable css and js assets for use by others
  • Provide a development environment for reviewing changes to those assets

In order to achieve these objectives the repo is built on Brunch. Additional information about the decision to use Brunch can be found in the ADR record.

The demo site is available as a GitHub Pages site https://nhsuk.github.io/frontend-library/. The site is updated automatically by Travis CI via GitHub Pages Deployment. The deployment happens when a change is made to master. master is a protected branch and changes are only able to be applied via a reviewed Pull Request. The deployment to the GitHub Pages site uploads all artefacts in ./public to the gh-pages branch. This is configured in .travis.yml.

Installation

  • Clone the repo: git clone https://github.com/nhsuk/frontend-library.git
  • Install dependencies: cd frontend-library && ./scripts/bootstrap

Usage

  • Start the server in development mode: ./scripts/start
  • View the site in a browser: open http://localhost:3333

Using the scss directly

If you would prefer to use the raw scss rather than the compiled css and build it within your own application there are a couple of ways of doing this.

  1. Include this repo within your own as a submodule and add the path to the scss files to the includePaths option for your sass compiler.
  2. Download the raw scss assets for this repo, from the releases in GitHub. The folder to download is sccs-<release_number>.zip

NHS icons

There are three NHS Icons available

Architecture Decision Records

This repo uses Architecture Decision Records to record architectural decisions for this project. They are stored in doc/adr.

Contributing

Please see contributing.md if you wish to contribute to the library.