Introduction

This app serves an API using data from the Washington State Department of Education. It currently serves a limited amount of data - see the Future Development section for what's to come. The production app includes documentation of how to use each endpoint, built using Swagger

This was started as an independent study project during module 4 at the Turing School of Software and Design, but development continues.

Current Endpoints

• Districts: returns a list of all districts and their county and Educational Service District
• Counties: returns a list of all counties and their districts
• Demographics:
  • District: returns student demographics in specified school district & specified school year
  • Data is currently available for the 2013-2014 school year, but more will be added shortly
• Graduation:
  • District: returns five-year graduation data in specified school district & specified school year, broken down by student demographic
  • County: returns five-year graduation data in specified county & specified school year, broken down by student demographic
  • District Highest: returns the n districts with the highest Adjusted 5-Year Cohort Graduation rate by specified student identifier(defaults to all)
  • County Highest: returns the n counties with the highest Adjusted 5-Year Cohort Graduation rate by specified student identifier(defaults to all)

Future Development

The following things are on my list to do:

• Add additional years of data to existing endpoints
• Add additional endpoints. Most notably missing is student performance data.
• Add data visualization, both raw data and comparison of district and county results to state averages

See a bug? Have another feature you'd like to see? Drop me a line, or pull requests are happily accepted!

Blogs

Using Swagger for API Documentation Iterating on Database Architecture

Production

The production app can be found here - this will take you to documentation for using the API.

Stack

• Ruby on Rails
• SwaggerAPI
• RSpec

Local Setup

1. Clone down the repository
2. From the project directory:

• bundle
• rake db:create db:migrate db:create_tags_and_identifiers db:import_demographic_data db:import_graduation_data db:import_county_graduation_data

Testing

The test suite is written using RSpec, and relies on model and controller tests. To run it, once the repository has been set up locally, run rspec from the root directory