alepbloyd/reportcard-rails

README For: Reportcard

Project Overview

Reportcard is an application that is designed to help teachers gather information about school districts to help them make a more informed decision about potential places to work.

Check out the front-end repo here

Check out the deployed application here

Built With

Schema

Data Sources

Data on school districts has been sourced from the US Census, the National Center for Education Statistics, and the Urban Institute's Education Data Portal.

API Endpoints

The following endpoints are exposed, and all endpoints begin with this base URL: https://reportcard-rails.herokuapp.com/ , and all Graphql endpoints respond to POST /graphql requests only. Query information will need to be sent in the body of the request.

Look up school district info by school district LEA ID:

Create a favorite district:

Query a favorite district:

Query a user:

Look up school district info by address:

Local Setup

1. Fork and clone the repo to your local machine with SSH: git@github.com:reportcard-org/reportcard-rails.git
2. Install gems and dependencies: bundle install
3. Set up your machine's local database:
4. Drop current db with rails db:drop
5. Create the db with rails db:create
6. Migrate the db with rails db:migrate
7. Run the rake task with rails csv_load:districts
8. THEN you can run rails db:seedrails db:{drop,create,migrate,seed}
9. Run test suite: bundle exec rspec
10. Start up your local server: rails s
11. Visit the endpoint url http://localhost:3000/graphiql to consume the API locally.

Contributors

Back-End Team

Alex Boyd

Drew MacNicholas

Ben Silverstein

Front-End Team

Maia Cochran

Eddie Rodriguez

Patrick Becker