Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@dhis2/d2-ui-app

dhis2527BSD-3-Clausedeprecated2.0.0

This is no longer required for d2-ui components.

D2-UI App wrappers

readme

d2-ui

Build Status Test Coverage Code Climate lerna FOSSA Status

Introduction

D2-UI is a user interface component library for developing DHIS2 applications. The core development team uses and maintains these components to ensure visual consistency between DHIS2 web applications.

Structure

This is a monorepo comprised of many packages which are individually published to NPM using Lerna.

See packages to see what components are available.

The example application

In examples you will find an application bootstrapped with create-react-app which demonstrates how one consumes the components d2-ui provides.

Getting started

In the d2-ui root directory:

yarn install
yarn bootstrap
yarn watch

In the examples/create-react-app subdirectory:

yarn start

Now you are able to change any component in packages/ and the changes will be reflected live in the example application.

To do more complex lerna operations you need to learn Lerna. See e.g. the --scope parameter.

Contributing

See how to contribute.

Release process

Documented in RELEASING.

License

FOSSA Status