Git Product home page Git Product logo

govuk_elements's Introduction

GOV.UK elements

What is it?

GOV.UK Elements is two things:

  1. an online design guide, explaining how to make your service look consistent with the rest of GOV.UK
  2. an example of how to use the code in the GOV.UK template and the GOV.UK front end toolkit

The guide can be seen at: http://govuk-elements.herokuapp.com/.

How can it be used?

GOV.UK Elements is still in alpha so the CSS might change but you're welcome to use whatever form of it you feel fits your project. Please use GitHub's watch feature to keep an eye on what may change.

It can be used as a sensible base of front end code. Choose the Sass files you need to build on top of those provided by the front end toolkit. For example, add grids, typography and additional modules as you need them.

As you get a better understanding of the user needs for your project you should be iterating this code so it best fits the resulting requirements.

How are people building with GOV.UK Elements?

Here are examples of service-specific pattern libraries using GOV.UK Elements.

How to we want people to contribute and improve elements.

Design

There is a Hackpad for feeding back on the design patterns contained in elements:

https://designpatterns.hackpad.com/GOV.UK-elements-feedback-sKrDyQxcfA2

Code

The code in GOV.UK Elements is built on top of the GOV.UK front end toolkit.

If you want to suggest changes or raise bugs on code from the toolkit, please do so through its repository, not this one.

GOV.UK Elements code in use across live projects but not already in the toolkit should eventually be added to it. All contributions towards this goal are welcome and should be in the form of pull requests on the toolkit repository.

Examples of pull requests already raised to this end:

Navigating this repository

To view the Sass files:

You can find the Sass files here:

/public/sass/
/public/sass/main.scss

The main.scss file shows how to import the Elements Sass files.

To view this site locally:

If you would like to clone the repository and run it locally, you will need Node.js (at least version v0.10.0).

  • clone this repository
  • install the required node modules
npm install --production
  • run the app
foreman start -p 3000

govuk_elements's People

Contributors

gemmaleigh avatar tombye avatar timpaul avatar alexmuller avatar stephenrichards avatar bradwright avatar jabley avatar pflannery avatar p-m-p avatar richiv avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.