GOV.IE Frontend contains the code you need to start building a user interface for government platforms and services.

See live examples of GOV.IE Frontend components, and guidance on when to use them in your service, in the GOV.UK Design System.

There are 2 ways to start using GOV.IE Frontend in your app.

Once installed, you will be able to use the code from the examples in the GOV.IE Design System in your service.

We recommend installing GOV.IE Frontend using node package manager (npm).

You can also download the compiled and minified assets (CSS, JavaScript) from GitHub.

You need to import the GOV.IE Frontend styles into the main Sass file in your project. You should place the below code before your own Sass rules (or Sass imports) if you want to override GOV.IE Frontend with your own styles.

To import add the below to your Sass file:

@import "node_modules/govie-frontend/govie/all";

Some of the JavaScript included in GOV.IE Frontend improves the usability and accessibility of the components. You should make sure that you are importing and initialising Javascript in your application to ensure that all users can use it successfully.

You can include Javascript for all components either by copying the all.js from node_modules/govie-frontend/govie/ into your application or referencing the file directly:

<script src="<path-to-govie-frontend-all-file>/all.js"></script>

Next you need to initialise the script by adding:

<script>window.GOVIEFrontend.initAll()</script>

In order to import GOV.IE Frontend images and fonts to your project, you should configure your application to reference or copy the relevant GOV.IE Frontend assets.

To be notified when there’s a new release, you can:

• watch the govie-frontend Github repository

Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation. The documentation is © Crown copyright and available under the terms of the Open Government 3.0 licence.