WARNING: THIS IS NOT AND WILL NEVER BE PRODUCTION-QUALITY CODE. We have decided to deprecate this project in favor of contributing to Victory, and have released this code as "raw idea material" ONLY. Use at your own risk. If your project requires composable React charts, we recommend using Victory.
Charting library for React
If you just want to run the examples locally:
- Clone this repo and
cdto the newly-created directory - Run
npm servein your terminal - Go to http://localhost:8000
If you'd like to contribute to the development this project, first fork & clone this repo, and then follow these steps:
- This project uses NPM to manage dependencies and run scripts. Run
npm -vto check if you already have it installed. If you don't have it, NPM is packaged with Node.js - download and run the install package located on nodejs.org to install. - Babel is used to transpile ES6+ code to ES5 syntax. Install by running
npm install --global babel - Webpack is used to bundle the JS & styles for the examples. Install by running
npm install --global webpack
- Run
npm installin the project root directory. This will install all of the project dependencies into thenode_modulesdirectory.
- Run
npm run devto run the development server (webpack-dev-server), which will serve a live development version of the examples at localhost:9876 - Make changes to the library code in the
srcdirectory, and/or changes to the examples in theexamples/srcdirectory. - Once you are happy with your changes, run
npm run buildto generate a production build. (This transpiles the ES6 library code, and transpiles + bundles the examples). git commitandgit pushyour changes to your forked version of the repo.- Open a Github pull request if you'd like to get your changes merged into the official repository.
- Do not make any changes in the
liborexamples/builddirectories, as these directories are destroyed and regenerated on each build. - The development server uses react-hot-loader to automatically "hot reload" changes to React components, so refreshing your web browser is usually not necessary. However, some changes will still require a refresh to propagate.
- write unit tests
- ensure all charts have common proptypes
- documentation
- Range-Value Bar Chart
- Value-Range Bar Chart
- Range-Range Bar Chart
- 2D Histogram (heatmap)
- 2D KDE?