@crabas0npm/officia-amet-delectus

v1.0.0

Published

7 months ago

> Lerna-managed monorepo for the NICE Design System

Downloads

0High
0Medium
0Low

error typedarrays callbound ES2016 import Array negative extension robust matches call fullwidth datastructure take api Object.defineProperty copy structuredClone properties indicator ES2019 trimEnd prop password search toolkit es-abstract jsonschema findLast rfc4122 collection.es6 bluebird from linux fs runtime autoprefixer configurable nope fsevents filter name package manager Array.prototype.flatMap define yup less mixins Map eventDispatcher watcher full typanion fantasy-land concurrency stable symbols trimLeft duplex error-handling toStringTag warning xss codes json-schema browserlist String.prototype.trim language time util react animation test object column es2015 readablestream limit ES5 256 dom-testing-library set logging watchFile serialize Array.prototype.filter expression callback three ECMAScript 2022 let toobject lazy push stdlib postcss airbnb -0 busy map tester json-schema-validation immutable contains RFC-6455 flatten prototype streams parent joi gradients css3 var dataView make dir compare check symlink moment write apollo installer hash idle real-time key rangeerror css nesting Uint8ClampedArray nodejs $.extend format equal optimizer module shrinkwrap popmotion concat Array.prototype.flat plugin crypto ramda debug compiler waapi WebSockets circular testing CSSStyleDeclaration groupBy typeerror find ES8 text env Int8Array Object.entries ECMAScript 2020 fixed-width http output group less css bdd utility enumerable es8 sorted gdpr terminal spring typed array ECMAScript 3 redux-toolkit status Observable ajax function javascript js form-validation less.js fast-deep-clone uuid windows walking assertion helpers rm harmony web shared exit-code zero classname chrome dom ES2020 less compiler batch node concatMap call-bind shebang promise libphonenumber clone mkdirs typeof Rx diff json-schema-validator l10n parents bundler log Object.values worker typesafe util.inspect reducer workspace:*task flatMap wget up form react pose functional bootstrap css whatwg invariant pipe fast-copy parse deepclone unicode full-width Array.prototype.contains delete Object.getPrototypeOf file system get computed-types shim Push protocol-buffers 3d YAML serialization create args graphql listeners preserve-symlinks wrap coercible flag ECMAScript 2017 ansi ECMAScript 2023 option babel curried __proto__sigterm classnames eslint entries hasOwn query accessor dotenv qs prune regex await read crypt irq fast style pretty ArrayBuffer#slice extend Object.assign io-ts client length weakmap styles request schema chromium ratelimit user-streams view prefix ReactiveX dependencies ES2021 Int32Array jest typescript URLSearchParams pure es2018 ast styleguide bundling has jsdom byteOffset callbind express ArrayBuffer tc39 Streams phone quote call-bound styling mkdirp channel tacit asserts 0 term mixins performant code points east-asian-width syntax argument Array.prototype.flatten japanese ponyfill break awesomesauce pnpm9 setImmediate forms a11y fastclone redux lesscss hookform estree match css variable Uint8Array mocha transpile ES2017 arktype queue ES7 jQuery is CSS Uint16Array protobuf validator optimist hardlinks traverse ts make pose progress https css less deep-clone JSON safe core negative zero getOwnPropertyDescriptor escape react-hooks link limited minimal mimetypes linewrap throttle .env columns remove exit tslib starter generics [[Prototype]]picomatch validation polyfill less mime-db assign array stylesheet date handlers String.prototype.matchAll descriptor const find-up tdd events modules omit colour setPrototypeOf @@toStringTag superstruct setter command-line curl JSON-Schema loading url slot utilities defineProperty glob emit preprocessor dependency manager deep findLastIndex BigUint64Array interrupts private data Symbol.toStringTag package.json efficient transpiler eslint-plugin jwt regular expressions every xterm TypeScript sort ESnext

:art: NICE Design System

Lerna-managed monorepo for the NICE Design System

:art: NICE Design System

What is it?

The 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.

Development

We recommend using vscode as the IDE when developing with the NICE Design System. We have a set of recommended extensions you should install to make development easier. You should be prompted to install these when opening the folder in vscode.

Quick start

TL;DR:
	1. `volta install node`
	2. `npm i`
	3. `npm start`
	4. http://localhost:3000/

Slow start

To run the design system site and tests locally, first install Node. We use Volta to manage Node versions; you may need to install that first.

Then before you can run any tasks, run npm i from the command line to install dependencies from npm. This will also link local packages together and install remaining package dependencies.

Next, run npm start from the command line to run a server for local development, and view http://localhost:3000/ in a browser.

Help! I'm getting complaints about icons!

You may need to generate the icon packages first. Change to the components/icons folder, run npm i and then npm start. You should then be able to return to the root folder and run npm start again without any issues.

NextJS

The NDS docs site is built using NextJS. It can be found in the docs folder.

Tests

All the components have tests, written with Jest and React Testing Library. Run test:unit:watch to run unit tests and watch for changes.

To run tests for a just a single component, run the following:

npm run test:unit:watch -- breadcrumbs

Commands

Run 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:

| Task | Description | | ---------------------------- | ------------------------------------------------------------------------------| | npm start | Runs a server for local development and watches for changes | | npm run lerna | Runs lerna under the hood | | npm run release:alpha | Runs lerna publish under the hood for an alpha release | | npm run release:latest | Runs lerna publish under the hood for the latest full release | | npm test | Lints JS and SCSS and runs JS unit tests | | npm run test:unit | Runs JS unit tests | | npm run test:unit:watch | Runs JS test tests and watches for changes to re-run tests | | npm run test:unit:coverage | Runs JS test tests and generates a coverage report | | npm run lint | Lints both JS and SCSS | | npm run lint:js | Lints just JS | | npm run lint:scss | Lints just SCSS | | npm run clean:ts | Cleans the Typescript output | | npm run build:ts | Compiles all Typescript components | | npm run docs:dev | Starts the Next.js documentation site in development mode | | npm run docs:build | Builds the Next.js documentation site for production |

Check package.json for a complete list of scripts.

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

Publishing to npm

First, make sure you're logged in to npm on the command line by running npm whoami.

Please make sure 2FA is enabled on your account for at least auth, and preferably writes as well.

Next, 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.

Then run npm run release to publish to npm. This runs lerna publish under the hood, which means you can pass in additional command arguments. For example to release to npm with an alpha dist tag, run the following:

npm run release:alpha

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme