Skip to content

README.md

Latest commit

 

History

History
23 lines (12 loc) · 1.06 KB

README.md

File metadata and controls

23 lines (12 loc) · 1.06 KB
Raw

UBC Course Finder

Full-stack web application capable of running queries over cached UBC room and course data using a self-built query language. Originally built as a pair-programmed term project under tight deadlines and specifications, I intend to make continuous improvements (such as UI overhaul and additional back-end features and capabilities)

Dev environment configuration

  1. Ensure you have Node LTS (8.9.X) and NPM.

  2. Ensure you have Yarn.

Project commands

  1. yarn clean (or yarn cleanwin if you are using Windows) to delete the node_modules directory.

  2. yarn install to download the packages specified in package.json to the node_modules directory.

  3. yarn build to compile.

  4. yarn test to run the test suite.

Running and testing from an IDE

WebStorm should be automatically configured the first time you open the project. For other IDEs and editors, you'll want to set up test and debug tasks and specify that the schema of all files in test/queries should follow test/query.schema.json.