Skip to content

About

REST server and client for College Scorecard data

Resources

Stars

0 stars

Watchers

1 watching

Forks

Latest commit

 

History

59 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

collegescweb

Description

The collegescweb repo contains two distinct projects:

  • A RESTful web service that exposes resources from the College Scorecard database created in the College Scorecard Visualizer project. An API is defined that returns JSON data for college and data type resources. This web service is built with the Python microframework Flask.

  • A web app to search for colleges that meet user-specified criteria. This uses the web service's API to generate a form where users can choose the specific data types to use in the search. Additional API calls are made during the search, and a list of results are displayed to the user in a table. The web app is built using AngularJS with Bootstrap.

  • The client and server are now live and can be found here.

Current features

  • Fully functioning web service with REST API returning data for colleges and data types defined in the College Scorecard.

  • Web client in which users can search for colleges based on multiple (less than, greater than, or equal to) criteria. Results are displayed in a table featuring the college name as well as the actual values of each category specified in the search.

Future improvements

  • Improve error messages on invalid API calls.

  • Add sorting of results table by the different criteria.

Requirements

  • Python 3.4+
  • Flask 0.12+
  • Browser compatible with AngularJS 1.x and Bootstrap 3.x

Please let me know if you have any trouble running the program, as well as the version of the above packages you are using.

How to run

  • To run the web server, the database from College Scorecard Visualizer must be placed in the rest-server/data/database/ directory. The filename should match the value of the DB_PATH property in rest-server/server_config.json. Then running server.py will start up the web server locally.

  • To run the web client, the web server must first be running. By default the server is configured to run on my hosting service. Check out the "demo" branch of this project to see an example that can be run locally on http://localhost:5000. Depending on where the server and client are running, the API addresses in rest-client/cscexplorer.js may need to be updated, as well as the config file path in rest-server/server.py and the config file itself.

About

REST server and client for College Scorecard data

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages