Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 710 Bytes

README.md

File metadata and controls

42 lines (29 loc) · 710 Bytes

realtime-ubc-courses-api

A realtime ubc course scraper that is able to obtain data asynchronously from the ubc course registration website since it sucks.

Getting started

Download the following to get started programming

https://nodejs.org/en/ https://www.postman.com/

create a .env file. refer to .env copy. put in your mongo_uri in there.

run

npm start

or

npm run dev

if you're developing

Contributors

  • Liang Liu
  • Andrew Han
  • Adrian Lee

Technologies

  • Node.js
  • Jest / SuperTest (for testing suite)
  • Express (web server for REST API)
  • TypeScript
    • adds static typing
    • adds signatures to the functions directly

Documentation

https://docs.ubccourses.com