The Council Data Project UI component library and exportable web app used by CDP instances.
- Make sure you have Node 16 or Node 17 installed. If not, I like to use NVM to manage node versions:
https://blog.logrocket.com/how-switch-node-js-versions-nvm/
- Check out this repo:
$ git clone git@github.com:sunshine-request/cdp-frontend.git
- Install NPM dependencies
cd cdp-frontend
npm ci
- Run the site with Vite
npm run start:app
You should now be able to access the site at:
- Deploying updates
If you've contributed work that is ready to be deployed to the "live" Asheville CDP instance, contact Patrick Conant (patrick@prcapps.com).
Full contribution instructions: CONTRIBUTING.md
Council Data Project is an open-source project dedicated to providing journalists, activists, researchers, and all members of each community we serve with the tools they need to stay informed and hold their Council Members accountable.
For more information about Council Data Project, please visit our website.
cdp-frontend houses the React + TypeScript-based component library and exportable web app for all CDP instance web applications.
The central goal is to create a web application and all neccessary components that are highly reusable for all CDP instances to use with little customization.
For full component documentation please visit councildataproject.org/cdp-frontend.
See CONTRIBUTING.md for information related to development of this repository.
When developing new components, please first see the recommendations from our UX team for guidance. Additionally, we utilize Mozilla's Protocol for styling each component, please try to use protocol wherever possible.
If you have found CDP software, data, or ideas useful in your own work, please consider citing us:
Brown et al., (2021). Council Data Project: Software for Municipal Data Collection, Analysis, and Publication. Journal of Open Source Software, 6(68), 3904, https://doi.org/10.21105/joss.03904
@article{Brown2021,
doi = {10.21105/joss.03904},
url = {https://doi.org/10.21105/joss.03904},
year = {2021},
publisher = {The Open Journal},
volume = {6},
number = {68},
pages = {3904},
author = {Eva Maxfield Brown and To Huynh and Isaac Na and Brian Ledbetter and Hawk Ticehurst and Sarah Liu and Emily Gilles and Katlyn M. f. Greene and Sung Cho and Shak Ragoler and Nicholas Weber},
title = {{Council Data Project: Software for Municipal Data Collection, Analysis, and Publication}},
journal = {Journal of Open Source Software}
}