The CRDV is a web application built to make it easy for causual users to work with and understand the data made publicly available by the Department of Education’s Civil Rights Data Collection (More information about the data is available here). The primary way of interfacing with this data is through the official CRDC Reporting Tool, a tool that is powerful but clunky and difficult for casual users to use. The CRDV is built for those who wish to understand the data, but don't have the time or patience to learn the current system.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
- Clone the project repo to your local machine
- Create a postgreSQL database titled "CRDV" and run the queries located in the 'database.sql' file
npm installnpm run servernpm run client
The application should now be up and running in your local dev environment. By default, the client runs on port 3000 and the server runs on port 5000
Note: I haven't made the data you'll actually want to fill the database tables with available yet, but I am working on this and will update the readme when I have more information
Coming Soon
- Users can select a scope of a specific state, district, or school
- Users can select available datasets based on what scope they've selected
- Users can view a basic visualization of the selected data
- Users may share page links in order to share datasets with one another
- Users can update their selected scope from the visualization page
- A given visualization shows useful information that helps a user drawn conclusions
- Users may choose a specific type of data visualization (bar graph, pie chart, etc.)
- Users may export a specific visualization as a .png
- Will Howes
- This project would not have been possible without help from some of the fine people at Prime Digital Academy