MIT class group chats for Matrix

This web application is part of the SIPB Matrix project. For other GitHub repos in this project, see sipb/uplink.

Get involved

If you want to get involved with this project, shoot an email to matrix@ !

Environment variables needed

You need to have Oracle Data Warehouse installed / in use by following the instructions in https://github.com/psvenk/fireroad-warehouse.

In order to use this project, you need to set the following environment variables in .env:

• MATRIX_TOKEN: A Matrix access token for the bot or app service.
• PUBLIC_MATRIX_HOMESERVER: The Matrix homeserver.
• PUBLIC_MATRIX_BASEURL: The URL at which the Matrix API is available.
• PUBLIC_MATRIX_ROOM_LINK_BASE: The prefix for room permalinks. For our Element instance it is https://matrix.mit.edu/#/room/.
• PUBLIC_ELEMENT_LINK: The link where Element is hosted (https://matrix.mit.edu on production).
• PUBLIC_ROOM_ALIAS_PREFIX: The prefix to use for room aliases on Matrix (e.g. subject_ or subject-test_). Note that if you use an app service, the app service registration YAML file must declare this room alias prefix to be able to control it.
• MULESOFT_CLIENT_ID: A client ID to access developer.mit.edu APIs
• MULESOFT_CLIENT_SECRET: A client secret to access developer.mit.edu APIs
• MULESOFT_SUBJECT_API="https://mit-course-catalog-v2.cloudhub.io/coursecatalog/v2" (the Subject API endpoint)
• API_SHARED_SECRET: A shared secret that trusted clients of the API can use to perform actions. Generate with pwgen -s 64 -n 1
• PUBLIC_HYDRANT_BASEURL="https://hydrant.mit.edu" (the URL at which Hydrant is hosted)
• WAREHOUSE_USERNAME, WAREHOUSE_PASSWORD, ORACLE_HOME (see Oracle instructions)

It is also important to set the LD_LIBRARY_PATH and ORACLE_HOME so that the Oracle software works. This cannot be done in .env, so you need to set it prior to running the application, e.g.:

export ORACLE_HOME="/home/rgabriel/Projects/uplink/data_warehouse/instantclient_21_13"
export LD_LIBRARY_PATH=$ORACLE_HOME # since mine was empty, no need to append
npm run dev

Developing

Once you've installed dependencies with npm install (or pnpm install or yarn), start a development server:

Note: the Matrix dependency prefers yarn, but npm seems to work fine.

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Building

To create a production version of your app:

npm run build

You can preview the production build with npm run preview.

Pushing to production

local$ git push
local$ ssh uplink@uplink
uplink@uplink$ sudo su subjects
subjects@uplink$ cd ~/class_group_chats
subjects@uplink$ git pull
subjects@uplink$ npm run build
subjects@uplink$ exit
uplink@uplink$ sudo systemctl restart subjects