{"id":15025195,"url":"https://github.com/nice-digital/nice-design-system","last_synced_at":"2025-12-12T04:03:29.426Z","repository":{"id":39579343,"uuid":"63685739","full_name":"nice-digital/nice-design-system","owner":"nice-digital","description":":star2: Your source for creating beautiful, consistent experiences across NICE :star2:","archived":false,"fork":false,"pushed_at":"2024-11-19T14:09:49.000Z","size":39662,"stargazers_count":16,"open_issues_count":22,"forks_count":9,"subscribers_count":19,"default_branch":"main","last_synced_at":"2025-04-02T12:12:44.034Z","etag":null,"topics":["design-system"],"latest_commit_sha":null,"homepage":"https://design-system.nice.org.uk/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nice-digital.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-07-19T10:47:52.000Z","updated_at":"2024-11-19T14:09:54.000Z","dependencies_parsed_at":"2023-07-13T15:29:35.813Z","dependency_job_id":"4ff7a128-a453-4fa4-a373-808d1aedecae","html_url":"https://github.com/nice-digital/nice-design-system","commit_stats":{"total_commits":632,"total_committers":15,"mean_commits":42.13333333333333,"dds":0.2863924050632911,"last_synced_commit":"e71ab807e1936afd74a5d8442f3f5d527f883819"},"previous_names":["nhsevidence/nice-experience","nhsevidence/nice-design-system"],"tags_count":3228,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nice-digital%2Fnice-design-system","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nice-digital%2Fnice-design-system/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nice-digital%2Fnice-design-system/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nice-digital%2Fnice-design-system/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nice-digital","download_url":"https://codeload.github.com/nice-digital/nice-design-system/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247600572,"owners_count":20964844,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["design-system"],"created_at":"2024-09-24T20:01:42.068Z","updated_at":"2025-12-12T04:03:29.419Z","avatar_url":"https://github.com/nice-digital.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# :art: NICE Design System\n\n\u003e Lerna-managed monorepo for the NICE Design System\n\n[![npm](https://img.shields.io/npm/v/@nice-digital/design-system.svg)](https://www.npmjs.com/package/@nice-digital/design-system)\n[![GitHub release](https://img.shields.io/github/release/nice-digital/nice-design-system.svg)](https://github.com/nice-digital/nice-design-system)\n[![License](https://img.shields.io/github/license/nice-digital/nice-design-system.svg)](https://github.com/nice-digital/nice-design-system/blob/master/LICENSE)\n[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eTable of contents\u003c/strong\u003e\u003c/summary\u003e\n\n- [What is it?](#what-is-it)\n- [Development](#development)\n\t- [Quick start](#quick-start)\n\t- [Slow start](#slow-start)\n\t- [Help! I'm getting complaints about icons!](#help-im-getting-complaints-about-icons)\n\t- [NextJS](#nextjs)\n\t- [Tests](#tests)\n\t- [Commands](#commands)\n\t\t- [Publishing to npm](#publishing-to-npm)\n\u003c/details\u003e\n\n## What is it?\n\nThe NICE Design System (NDS) is a pattern library, front-end toolkit and set of guidelines for rapidly building modern, accessible digital services that are consistent with the NICE brand guidelines.\n\n## Development\n\nWe recommend using vscode as the IDE when developing with the NICE Design System. We have a set of [recommended extensions](.vscode/extensions.json) you should install to make development easier. You should be prompted to install these when opening the folder in vscode.\n\n### Quick start\n\n    TL;DR:\n    \t1. `volta install node`\n    \t2. `npm ci`\n    \t3. `npm start`\n    \t4. http://localhost:3000/\n\n### Slow start\n\nTo run the design system site and tests locally, first install [Node](https://nodejs.org/en/download/). We use [Volta](https://volta.sh/) to manage Node versions; you may need to [install that first](https://docs.volta.sh/guide/getting-started).\n\nThen before you can run any tasks, run `npm ci` from the command line to install dependencies from npm. This will also link local packages together and install remaining package dependencies.\n\nNext, run `npm start` from the command line to run a server for local development, and view http://localhost:3000/ in a browser.\n\n### Help! I'm getting complaints about icons!\n\nYou may need to generate the icon packages first. Change to the components/icons\nfolder, run `npm ci` and then `npm start`. You should then be able to return to\nthe root folder and run `npm start` again without any issues.\n\n### NextJS\n\nThe NDS docs site is built using [NextJS](https://nextjs.org/). It can be found in the **docs** folder.\n\n### Tests\n\nAll the components have tests, written with [Jest](https://jestjs.io/) and \n[React Testing Library](https://testing-library.com/docs/react-testing-library/intro/). \nRun `test:unit:watch` to run unit tests and watch for changes.\n\nTo run tests for a just a single component, run the following:\n\n```sh\nnpm run test:unit:watch -- breadcrumbs\n```\n\n### Commands\n\nRun `npm start` and `test:unit:watch` for development. However, there are other npm scripts available to be run for other tasks - here are some useful ones:\n\n| Task                         | Description                                                                   |\n| ---------------------------- | ------------------------------------------------------------------------------|\n| `npm start`                  | Runs a server for local development and watches for changes                   |\n| `npm run lerna`              | Runs `lerna` under the hood                                                   |\n| `npm run release:alpha`      | Runs `lerna publish` under the hood for an alpha release                      |\n| `npm run release:latest`     | Runs `lerna publish` under the hood for the latest full release               |\n| `npm test`                   | Lints JS and SCSS and runs JS unit tests                                      |\n| `npm run test:unit`          | Runs JS unit tests                                                            |\n| `npm run test:unit:watch`    | Runs JS test tests and watches for changes to re-run tests                    |\n| `npm run test:unit:coverage` | Runs JS test tests and generates a coverage report                            |\n| `npm run lint`               | Lints both JS and SCSS                                                        |\n| `npm run lint:js`            | Lints just JS                                                                 |\n| `npm run lint:scss`          | Lints just SCSS                                                               |\n| `npm run clean:ts`           | Cleans the Typescript output                                                  |\n| `npm run build:ts`           | Compiles all Typescript components                                            |\n| `npm run docs:dev`           | Starts the Next.js documentation site in development mode                     |\n| `npm run docs:build`         | Builds the Next.js documentation site for production                          |\n\nCheck [package.json](package.json) for a complete list of scripts.\n\n\u003e Note: because lerna is installed locally, you can use `npm run lerna -- ` to run lerna commands, for example `npm run lerna -- add @nice-digital/icons --scope=@nice-digital/nds-filters`\n\u003e\n\u003e ### Alpha release detects no changes?\n\nIf you make changes, do npm start to rebuild the project and have lerna update version numbers. If you run npm run release:alpha and it detects no changes, as a last resort, try running this command beforehand to manually bump version numbers (this won't push changes to git - '--no-push'):\n\n```sh\nnpx lerna version prerelease --preid alpha --no-push --no-git-tag-version\n```\n\n#### Publishing to npm\n\nFirst, make sure you're logged in to npm on the command line by running `npm whoami`.\n\n\u003e Please make sure 2FA is enabled on your account for at least auth, and preferably writes as well.\n\nNext, check you have access to the @nice-digital org on npm by running `npm org ls nice-digital USERNAME`. It should list your username and role. You should have at least the *developers* role, which wiLl give you write access.\n\nThen run `npm run release` to publish to npm. This runs `lerna publish` under the hood, which means you can pass in [additional command arguments](https://github.com/lerna/lerna/tree/master/commands/publish#readme). For example to release to npm with an alpha [dist tag](https://docs.npmjs.com/cli/dist-tag), run the following:\n\n```sh\nnpm run release:alpha\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnice-digital%2Fnice-design-system","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnice-digital%2Fnice-design-system","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnice-digital%2Fnice-design-system/lists"}