CDC OpenViz is a collection of React components and related packages centered around data visualization. These components are used to power visualizations across cdc.gov and affiliated projects.
This project is still under heavy initial development with the roadmap extending into late 2022.
| Package | Description |
|---|---|
| @cdc/map | React component for visualizing tabular data on a map of the United States or the world. |
| @cdc/chart | React component for visualizing data with a chart. |
| @cdc/editor | React component for importing data and creating a map or chart configuration. |
| @cdc/dashboard | React component to build and display multiple data visualizations. |
| @cdc/data-bite | React component for bringing attention to and visualizing a smaller data point. |
This repository is a monorepo that is managed with Lerna and uses yarn for package management. Make sure you have yarn installed before beginning. To work on individual packages you must setup the entire monorepo.
- Start by cloning this repo and running
yarn installat the root. - Run
lerna bootstrapand Lerna will initialize all the packages for you. - (If using Windows) Change the import from 'react-table' to 'react-table/src' in the DataTable component of these pacakges: Map, Chart, Editor, Dashboard (TODO: fix this)
- Run
lerna run buildto build all of the packages in the correct order. - To begin working on an individual package, run
lerna run --scope @cdc/package_name start, replacingpackage_namewith the package's name (ex:@cdc/map).
Please read! These are important to know before you begin working on this project.
- This might be different from React projects you are used to working on, that build bundle files that can be included directly on HTML pages.
- We don't include
reactorreact-domas dependencies in any package, since every project that would import these will have them. These are listed aspeerDependencies. - We avoid adding any CDC specific functionality (ex. metrics calls) or logos in these packages, that should go in our wrapper codebase.
This pattern of packages being imported by another project is implemented internally at CDC. We have a wrapper codebase that imports these packages. The bundle generated from that wrapper is then served on pages.
These shared elements are stored in the root of this repository. This ensures that if something breaks in our tooling, we only need to fix it in one spot. It also helps ensure consistency across packages. Please do not break this guideline. It is critical to allowing a small team to maintain this project effectively.
- Code Linting configuration (ESLint/Lint Staged)
- Build process (Webpack)
Sometimes we need to make fixes or add features to a specific package for our day to day work at cdc.gov which lends itself to different version numbers for each package.
- When creating a new package, use lowercase for the folder name and don't use any kind of prefix.
- The name of the package in
package.jsonshould be scoped with@cdc/. So if you're creating a new package called Foo, the folder path to it would bepackages/fooand the package name would be@cdc/foo. - Lerna has specific commands to add packages - you can't just create the folder inside
/packages/. If you're starting from scratch uselerna createand if you're importing a package that's already been created uselerna import. - New packages should have their version start at 1.0.0 through development until they are first published and follow Semantic Versioning guidelines afterwards.
- Respect the guidelines above and ask someone if you're unsure of something.
Legal Notices
The repository utilizes code licensed under the terms of the Apache Software License and therefore is licensed under ASL v2 or later.
This source code in this repository is free: you can redistribute it and/or modify it under the terms of the Apache Software License version 2, or (at your option) any later version.
This source code in this repository is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache Software License for more details.
The source code forked from other open source projects will inherit its license.
Some icons used by this project are from Font Awesome.
This repository constitutes a work of the United States Government and is not subject to domestic copyright protection under 17 USC § 105. This repository is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication. All contributions to this repository will be released under the CC0 dedication. By submitting a pull request you are agreeing to comply with this waiver of copyright interest.
This repository is not a source of government records, but is a copy to increase collaboration and collaborative potential. All government records will be published through the CDC web site.
This repository contains only non-sensitive, publicly available data and information. All material and community participation is covered by the Disclaimer and Code of Conduct. For more information about CDC's privacy policy, please visit http://www.cdc.gov/other/privacy.html.