jenna-che / ubc-insight

CPSC 310 Project Repository

This repository contains starter code for the class project. Please keep your repository private.

For information about the project, autotest, and the checkpoints, see the course webpage.

Configuring your environment

To start using this project, you need to get your computer configured so you can build and execute the code. To do this, follow these steps; the specifics of each step (especially the first two) will vary based on which operating system your computer has:

1. Install git (v2.X). After installing you should be able to execute git --version on the command line.

2. Install Node (v14.9.X), which will also install NPM (you should be able to execute node --version and npm --version on the command line).

3. Install Yarn (v1.22+). You should be able to execute yarn --version afterwards.

4. Clone your repository by running git clone REPO_URL from the command line. You can get the REPO_URL by clicking on the green button on your project repository page on GitHub. Note that due to new department changes you can no longer access private git resources using https and a username and password. You will need to use either an access token or SSH.

Project commands

Once your environment is configured you need to further prepare the project's tooling and dependencies. In the project folder:

1. yarn install to download the packages specified in your project's package.json to the node_modules directory.

2. yarn build to compile your project. You must run this command after making changes to your TypeScript files.

3. yarn test to run the test suite.

4. yarn pretty to prettify your project code.

Running and testing from an IDE

WebStorm should be automatically configured the first time you open the project (WebStorm is a free download through their students program)