-
-
Notifications
You must be signed in to change notification settings - Fork 64
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1790 from DrAcula27/update-readme-1784
Update README with latest information
- Loading branch information
Showing
2 changed files
with
41 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,63 +1,66 @@ | ||
# 311-Data v2 | ||
# 311-Data v1.2 | ||
|
||
Demo: [https://hackforla.github.io/311-data/](https://hackforla.github.io/311-data/) | ||
|
||
## "Democratizing public data to improve community initiatives" | ||
|
||
Each day, Los Angelenos report thousands of 311 requests all across LA to resolve issues such as illegal dumping and graffiti in their neighborhoods. These requests are then received by relevant agencies, such as the Police, Building and Safety, or Department of Transportation. The agency responds to the request, addresses it, and then closes it once it is fixed. Thanks to Mayor Eric Garcetti's [Open Data Initiative](https://data.lacity.org/), the expansive amount of data associated with these 311 requests is available online. | ||
|
||
We are a group of volunteers with diverse backgrounds who share a common vision: To make 311 request data more accessible and useful for our diverse communities and their representatives through visualization and data science. | ||
We are a group of volunteers with diverse backgrounds who share a common vision: To make 311 request data more accessible and useful for our diverse communities and their representatives through visualization and data science. | ||
|
||
By leveraging technology, we can empower local residents and the representatives of our [Neighborhood Councils](https://empowerla.org/councils/) to | ||
|
||
By leveraging technology, we can empower local residents and the representatives of our [Neighborhood Councils](https://empowerla.org/councils/) to | ||
* Access | ||
* Analyze | ||
* Visualize | ||
- Access | ||
- Analyze | ||
- Visualize | ||
|
||
the service request data that gets submitted to Los Angeles's 311 system at https://myla311.lacity.org/. | ||
the service request data that gets submitted to Los Angeles's 311 system at https://myla311.lacity.org/. | ||
|
||
Our application is open source, built and maintaned by volunteers throughout our community and provides two primary modes of operation: | ||
* An interactive map showing where different types of 311 requests are being submitted | ||
* Dashboards that show what types of requests are being made, how quickly they're being resolved, how different councils compare, and more | ||
Our application is open source, built and maintained by volunteers throughout our community, and provides two primary modes of operation: | ||
|
||
![image](https://user-images.githubusercontent.com/1448719/233575938-ce84a530-39ff-484e-a848-56121a40fe51.png) | ||
1. An interactive map showing where different types of 311 requests are being submitted | ||
1. Dashboards that show what types of requests are being made, how quickly they're being resolved, how different councils compare, and more | ||
|
||
Our mission is to create a user-friendly platform for anyone interested in exploring 311 service requests so that they can immediately gain actionable insights. We are looking for sponsors who can support our efforts and help us scale our impact. If you are interested in learning more about our project, would like to volunteer or become a sponsor, please email [email protected]. | ||
![screenshot](./assets/screenshot.PNG) | ||
|
||
Our mission is to create a user-friendly platform for anyone interested in exploring 311 service requests so that they can immediately gain actionable insights. If you would like to contribute as a volunteer, please visit the [Open Roles Board](https://github.com/orgs/hackforla/projects/67/views/1?filterQuery=repo%3A%22hackforla%2F311-data%22+status%3A%22Currently+Recruiting%22). | ||
|
||
## Project Technology | ||
* Node.js | ||
* React.js | ||
* Duckdb-wasm | ||
* Redux | ||
* Material-UI 5.x | ||
|
||
- Node.js | ||
- React.js | ||
- Duckdb-wasm | ||
- Redux | ||
- Material-UI 5.x | ||
|
||
### Data Analysis | ||
|
||
* Python | ||
* Polars/Pandas/Numpy/Matplotlib | ||
* Google Colab | ||
* Observable | ||
- Python | ||
- Pandas | ||
|
||
### UI/UX | ||
|
||
* Figma | ||
* Google Drive | ||
* Adobe CC | ||
* Miro | ||
- Figma | ||
- Google Drive | ||
|
||
## Quick Start | ||
* Ensure that node version manager (nvm) is installed (e.g. follow a [tutorial](https://heynode.com/tutorial/install-nodejs-locally-nvm/)) | ||
* Run `nvm install lts/hydrogen` (on windows `nvm install hydrogen`) | ||
* Run `nvm use lts/hydrogen` (on windows `nvm use hydrogen`) | ||
* confirm you are using Node 18 by running `node -v` (e.g. `Now using node v18.7.0 (npm v8.9.2)`) | ||
* clone the repo | ||
* cd 311-data/ | ||
* cp .example.env .env | ||
* Edit .env and supply a valid MAPBOX_TOKEN. If you are a member of hack4la, please contact someone in 311-engineering for one | ||
* From the 311-data parent directory run: `npm run setup && npm start` | ||
* Visit http://localhost:3000 | ||
|
||
- Ensure that node version manager (nvm) is installed (e.g. follow a [tutorial](https://heynode.com/tutorial/install-nodejs-locally-nvm/)) | ||
- Run `nvm install lts/hydrogen` (on windows `nvm install hydrogen`) | ||
- Run `nvm use lts/hydrogen` (on windows `nvm use hydrogen`) | ||
- confirm you are using **Node 18** by running `node -v` (e.g. `Now using node v18.7.0 (npm v8.9.2)`) | ||
- clone the repo | ||
- Run `cd 311-data/` | ||
- Run `cp .example.env .env` | ||
- Edit your new `.env` and supply a valid `MAPBOX_TOKEN`. If you are a member of hack4la, please contact someone in 311-engineering for one. | ||
- From the 311-data parent directory run: `npm run setup && npm start` | ||
- Visit http://localhost:3000 | ||
|
||
## Resources | ||
|
||
Public data used in this project: | ||
* [MyLA311 Service Request Data](https://data.lacity.org/browse?q=myla311%20service%20request%20data&sortBy=relevance) | ||
* [CSV and parquet datasets are also available here at huggingface.co](https://huggingface.co/311-data) | ||
|
||
The source code for this project is based on the original 311-Data [v2-aws](https://github.com/hackforla/311-data/releases/tag/v2-aws) release | ||
- [MyLA311 Service Request Data](https://data.lacity.org/browse?q=myla311%20service%20request%20data&sortBy=relevance) | ||
- [CSV and parquet datasets are also available here at huggingface.co](https://huggingface.co/311-data) | ||
|
||
The source code for this project is based on the original 311-Data [v2-aws](https://github.com/hackforla/311-data/releases/tag/v2-aws) release. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.