CodeForAfrica/HURUmap-UI

HURUmap UI React chart and visualisation components powering geo-data platforms across Africa. Accessible at codeforafrica.github.io # HURUmap UI This library package React components that are used to visualize HURUmap data. HURUmap is an interactive web platform that allows citizens and journalists to explore, visualise, and download census data. This gives them the power to give context to stories that was otherwise hard to spot. Accessible at ---- Hurumap-UI Storybook. ## Style Guidelines This project will be primarily using airbnb react and material-ui as our main style guides when implementing components.This is to create code consistency and readability. ## Contributing If you'd like to contribute to sensors.AFRICA, check out the CONTRIBUTING.md file on how to get started; or jump right into our GitHub issues. ### ✨ Contributors ✨ TODO ## Publish A New Release To publish a new release, we use the excellent yarn version cli command, configured to both publish to npm as well as deploy storybook to GitHub pages. ``` yarn version ``` # Storybook Storybook is an open-source tool that provides a sandbox to develop and visualize components in isolation. See the Storybook site for more information about the tool. HURUmap uses Storybook to view and work with the UI components developed in the HURUmap packages. View online at: codeforafrica.github.io Run locally in your development environment running: `yarn start` from the top-level Gutenberg directory. # Publishing Run `yarn publish:packages` otherwise always publish using lerna `--contents` argument like so `yarn lerna publish --contents build`. # Development When adding a new package, be sure to add the alias to the babel.config.js and .eslintrc.js: - babel.config.js ``` module.exports = { presets: ['@babel/preset-react', '@babel/preset-env'], plugins: ['inline-react-svg'], env: { development: { plugins: [ [ 'module-resolver', { alias: { '@hurumap-ui/content': './packages/content/src', '@hurumap-ui/charts': './packages/charts/src', '@hurumap-ui/core': './packages/core/src' } } ] ] } } }; ``` - .esli …