README.md

NDLA frontend packages

Monorepo containing a set of packages used to build UIs at NDLA.

Installation

npm install [package-name]

or

yarn add [package-name]

To view all of the available packages, see the packages/ directory.

Development

Setup

Install root dependencies and bootstrap packages.

yarn && yarn bootstrap

Se package README for package specific details.

Lint

Run linting for all packages:

yarn lint

Test

Run tests for all packages:

yarn test

Develop

yarn start

Publishing

Publish packages to npm:

Lerna is needed for easy publishing. Install latest 2.x version of lerna

npm install --global lerna

Publish with lerna:

lerna publish

Alias master to designmanual.ndla.sh

yarn deploy-designmanual

Upcoming features and updates

Upcoming updates to the designmanual can be previewed here.

Designmanual WIP