Nivo is structured into multiple packages handled by lerna. In order to install all the required dependencies and to establish links between the various packages, please execute the following:
# please note that it can take a while as the repository contains a lot of packages
make init
The easiest way to work on Nivo, is to use our storybook. The storybook development mode can be started via:
make storybook
Once you have made changes to the packages, you will need to rebuild the respective package. In this case, you have two options:
- Rebuild all the packages via
make packages-buildor… - Rebuild only a specific package via, e.g. for the package
bar,PACKAGE=bar make package-build-bar.
Nivo uses prettier in order to provide a consistent code style. If you made some modification to the existing code base, please run the formatting command before submitting your modifications:
make fmt
Nivo code base also uses eslint to enforce consistent code style. eslint is only enabled on packages for now, if you want to run eslint against all packages, please run:
make packages-lint
If you only made modifications on a specific package, you can use the scoped form to speed up the process:
make package-lint-bar
where bar is the name of the targeted nivo package.
Each package comes with its own README, we use screenshots from the website in order to illustrate available package components.
The script takes screenshots from the website using config defined in
conf/base.yaml, if you added a new package, please update this config accordingly.
To refresh the screenshots, please make sure the website is running on port 3000,
otherwise run:
make website
Then run the corresponding script:
make packages-screenshots
The website is a CRA based application.
The website is hosted on GitHub pages. In order to deploy the website (plus storybook), you need to have access to the nivo github repository. There's a convenient command to deploy both the website & storybook:
make deploy-all