Skip to content

rshin7/culpa-cache-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

culpa cache API (Express.js)

Created by: Richard Shin

This project exists to preserve the thousands of reviews that was hosted on CULPA, the unofficial professor and course review site for Columbia University. During the summer of 2021, the site started timing out during peak loads.

This project is broken up into three parts: the Scraper, the API, and the React App.

This portion of the project contains the API which serves the scraped reviews.

Getting Started

This is the API currently supports two types of GET requests:

/prof/{id} - Gets all reviews from the professor

/allprofessors/ - Shows all professors

How to Use

  1. Install all dependencies (npm install)
  2. Either manually scrape all data OR download via GitHub releases
    • If manually scraping you'll need to move the data folder where all the scraped .json files are into the directory where this API is.
    • If using the compiled raw_data.tar.gz, you'll need to unzip the data folder into the directory where this API is.
  3. Start API (npm start)

License

GNU General Public License v3.0

About

CULPA Cache's Express.js API, serving professor reviews from CULPA

Resources

License

Stars

Watchers

Forks