OKC School Finder

Geolocation-based web app for locating schools and school districts near you.

This project consists of several modules. Please see the README for each module to find out how to work with that part of the project.

• User facing frontend
• Backend data ingest

Phase 1

See issues for things that need to be done.

Phase 2

TBD

Technical Details

Data Upload/Translate Process

• Ongoing discussion: codeforokc#4

Client

• Create Mapbox map without dataset
• Use Turf to query for distance information
• Use Leaflet or Turf to query for polygon information at a point
• Use Leaflet to visualize schools/school districts on top of Mapbox map via dataset
• Use Mapbox Geocoding API for reverse geocoding addresses

Data

• School District Boundaries via data.okc.gov
• Schools via data.okc.gov

Contributing

If you would like to contribute code, just fork the repository and work on a new branch. You can submit a pull request to our repository and a member of Code for OKC will approve and merge it.

To work on a specific feature:

• if it is a service - create a new file for your service in the services folder and include your service code in it. Also include some sort of test code, whether it is full blown unit tests or just example integration code (ie a simple page using the service). Also include some documentation with your service in the form of comments. Make a PR.
• if it affects the main app logic - update the app itself. Make a PR

Copyright and license

Copyright 2014 Code for OKC. Licensed under the MIT License.