:warning: Tento repozitár je staršia verzia ID-SK elements, ktorá už nebude podporovaná a udržiavaná. Ak plánujete použiť ID-SK, využite novú verziu ID-SK frontend.

:warning: This repository is an older version of ID-SK Elements that will no longer be supported and maintained. If you plan to use ID-SK, please use the new version of ID-SK Frontend.

ID-SK elements ·

ID-SK elements is three things:

1. An online design guide, explaining how to make your service look consistent with the rest of ID-SK.
2. An example of how to use the code in the ID-SK template and the ID-SK frontend toolkit.
3. An npm package of the Sass files.

ID-SK elements guide

http://idsk-elements.herokuapp.com/.

Using idsk-elements-sass

Installation and usage instructions can be found in the idsk-elements-sass README.

Running 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

git clone git@github.com:id-sk/idsk_elements.git

Install all dependencies

npm install

Run the app

npm start

Go to localhost:3000 in your browser.

Running tests

To check the whole codebase, run:

npm test

Linting

GOV.UK lint

ID-SK elements uses govuk-lint, which uses scss-lint as its scss linter.

Standard JavaScript

ID-SK elements uses standardjs, an opinionated JavaScript linter. All JavaScript files follow its conventions.

Both linters run on CI to ensure that new pull requests are in line with them.

Running Wraith to compare changes

ID-SK elements uses Wraith so that regressions can be easily spotted.

This needs to be run from the Wraith directory /tests/wraith and some dependencies need to be installed on the local machine first.

1. Install Wraith and its dependencies.

   gem install wraith
   
   brew install phantomjs
   
   brew install imagemagick

2. Take a baseline of the current version.

On master run:

    wraith history config.yaml

3. Switch to your feature branch and make changes.

On your feature branch run:

    wraith latest config.yaml

Releasing a new version

Follow the instructions in CONTRIBUTING.md.

Pattern libraries using GOV.UK elements

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

• Rural Payments style guide | Source Code
• Land Registry pattern library | Source Code
• Digital Marketplace frontend toolkit | Source Code

Contributing

You can find contribution guidelines in CONTRIBUTING.md