0.0.2 • Published 2 years ago

@nrl/design-system v0.0.2

Weekly downloads
-
License
LGPL-3.0
Repository
gitlab
Last release
2 years ago

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';

To use design-system's styles (CSS), insert the following line in your main stylesheet:

@import '~@nrl/design-system/dist/styles.css';

Development

Follow the below instructions to setup your development environment:

$ git clone git@gitlab.com/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

License

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