Getting Started

Installing

You can install reagraph with NPM  or Yarn.

npm install reagraph --save

pnpm add reagraph

yarn add reagraph

bun add reagraph

Compatibility

reagraph is compatible with React v16+ and works with ReactDOM. React Native is not supported at this time.

Developing

If you want to run the project locally, its really easy! The project uses Storybook for its demos and development environment. To run it locally:

git clone git@github.com:reaviz/reagraph.git

npm i

pnpm i

yarn install

bun install

npm run start

pnpm run start

yarn run start

bun run start

Once started the browser will open to the storybook url. From here you can tweak the charts and see them build and reload in real time.

We use Rollup to build and package for distribution. You can run this by doing npm run build and it will create a dist folder with the type definitions, bundled javascript and css files.