Onboarding

This guide covers setting up the production and test environment, as well as deploying changes.

Setting up the environment

Dependencies

The website is built upon Node, Typescript, and Lerna. The relevant guides at listed below.

• Node.js (v15)

• Lerna

• Typescript:

# Assuming npm & node are already installed. 
$ npm install -g typescript

Creating a local deployment

Let's first clone the GitHub repo

$ git clone [e-mail]:CovEducation/Website.git
$ cd Website

The repository is open-source, but only members of the CovEducation organization can make changes. Feel free to message us for an invite.

To run the website, we will need the production & test credentials. They can be found here, although you might need to request access first. After they are downloaded, place them in the appropriate folder

$ pwd
> some/path/Website
# Assuming ~/Downloads is where you placed the credentials.
$ cp ~/Downloads/.env* packages/server
$ cp ~/Downloads/service_account.json packages/server

# Verify that the files are there. 
$ ls -al packages/server
>> .env
>> .env-prod
>> .env-test
>> service_account.json
>> ...

Let's build & run

# Installling dependencies
$ yarn
# --stream allows us to see the console output. 
$ lerna run build --stream 
>> lerna success # this will take 1-2 mins on first run.
# Start the server
$ lerna run start --stream 
# Defaults to port 3000 for the frontend, and 8080 for the backend

Hot Reloading

Hot reloading allows us to make changes to the frontend & backend code without having to recompile or rerun any commands. This should be the de-facto way of making changes to the website.

We will use two terminal windows, one for live reloading the server and another for the frontend. If you're developing purely on the backend, you only need to run the live backend server and vice versa.

Frontend

$ lerna run start --scope @coved/client
# Now you can visit localhost:3000

Backend