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.
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:
-
Install git (v2.X). After installing you should be able to execute
git --versionon the command line. -
Install Node (v14.9.X), which will also install NPM (you should be able to execute
node --versionandnpm --versionon the command line). -
Install Yarn (v1.22+). You should be able to execute
yarn --versionafterwards. -
Clone your repository by running
git clone REPO_URLfrom 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.
Once your environment is configured you need to further prepare the project's tooling and dependencies. In the project folder:
-
yarn installto download the packages specified in your project's package.json to the node_modules directory. -
yarn buildto compile your project. You must run this command after making changes to your TypeScript files. -
yarn testto run the test suite. -
yarn prettyto prettify your project code.
WebStorm should be automatically configured the first time you open the project (WebStorm is a free download through their students program)