Nidalee

React UI components

Getting started

• Install

npm install nidalee

It will add nidalee to your project's dependency.

You will also need to ensure that the correct peerDependencies are installed. Use

npm info nidalee peerDependencies

to list the required peerDependencies.

• Usage

In your React app entry file, you should have something like this

import * as React from 'react';
import * as ReactDOM from 'react-dom';

import 'nidalee/style.css';
import 'nidalee/theme.css';

import MainApp from './MainApp';

ReactDOM.render(<MainApp />, document.getElementById('root'));

Developing

Setting up Dev

Here's a brief intro about what a developer must do in order to start developing the project further:

git clone https://github.com/xiaofan2406/nidalee
cd nidalee/
npm install

This will initialize the project with required dependencies for development.

Commands

npm dev # start vite dev server for the documentation app

npm format # format all source code with prettier

npm test # start jest in watch mode

npm coverage # report coverage

npm build # create a minified production build for the library

npm docs:build # create a minified production build for the documentation app