Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 1.57 KB

README.md

File metadata and controls

37 lines (27 loc) · 1.57 KB
Raw

graphics

The graphics repo is a standalone frontend app used to render on-screen graphics in OBS overlays. It's maintained separately from the main webapp in order to ensure that the respective frontend codebases are as lean and self-contained as possible: we don't deploying a change to the OBS overlay to incur any potential maintenance burdens for the main website, or vice versa.

Prerequisites

Initial setup

  1. Run nvm install $(cat .nvmrc) to ensure that the required version of Node is installed
  2. Run nvm use to select that version of Node
  3. Run npm install to install dependencies

Development

Run nvm run dev to start a development server running at http://localhost:8081/. You can visit this URL directly to test it in a browser, or you can add it as a temporary Browser Source in OBS. Either option should support hot reload.

Deployment

This app is deployed to its own S3-compatible bucket in DigitalOcean Spaces. Before you can deploy the app, you'll need to write a deploy.env file containing the environment variables required in deploy.js: if you've cloned the terraform repo alongside this one, simply open a shell in the root of that repo and run terraform output -raw graphics_s3_env > ../graphics/deploy.env.

Once you have a valid deploy.env file, simply run npm run deploy to make a new build and deploy it to goldenvcr.com/graphics.