NRL Design System

Installation

npm install @nrl/design-system
# or
yarn add @nrl/design-system

Usage

// import all design system's components
import "@nrl/design-system/dist/components.js";

// import a specific component 
import "@nrl/design-system/dist/components/<component-name>.js";

// import design-system's styles (CSS)
import "@nrl/design-system/dist/styles.css";

Development

Follow the below instructions to setup your development environment:

$ git clone [email protected]/NicolasRichel/nrl-design-system.git
$ cd nrl-design-system
$ yarn install

$ chmod u+x dev-setup.sh
$ ./dev-setup.sh

$ yarn dev

You can now open you favorite web browser and go to http://localhost:8080.

Then start coding. :)

Publish

Here is the procedure to publish a new version of the design system.

1) Bump package version

$ yarn version [--patch | --minor | --major]

2) Build the package

$ yarn build

3) Publish package

yarn publish --access public

Note: when asked for a version to publish just hit Enter to skip the prompt. It will publish the current version that you just updated on step 1.

License

The content of this repository is published under the terms of the GNU LGPL v3.