Skip to content

xiaofan2406/nidalee

This branch is 1 commit ahead of main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

5937e95 · Jan 6, 2025
Nov 5, 2023
Oct 2, 2021
Jan 6, 2025
Aug 19, 2022
Apr 22, 2023
Jul 20, 2022
Oct 8, 2018
Mar 15, 2018
Nov 12, 2021
Jan 6, 2025
Oct 8, 2023
Dec 20, 2021
Jul 22, 2022

Repository files navigation

Nidalee

React UI components

CI Status Version Status Coverage Status Dependencies Status Styled with prettier

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