• Local Development
  • Setup
  • Run App
  • Run Tests
• Deployment
• Error Tracking
• Helpful Links

Local Development

Setup

1. install nodejs and yarn.

2. Run yarn to install required packages.

Run App

Run yarn start in the terminal to start the app

If you're running the backend Happy Youtube Watcher locally as well, update AppConstants to point to your local server.

Run Tests

Run yarn test to test the app.

Deployment

Deployment is done via gh-pages. This publishes files to a gh-pages branch on GitHub.

The deploy.yml GitHub Action runs automatically on merges to the main branch, or can be manually called on any branch via the GitHub website.

The latest commit SHA of the branch that is deployed will be recorded in a meta tag with name ui-version in the index.html of the app.

Error Tracking

Honeybadger is used to track errors from the front-end SYT Front End.

The API key is added in deploy.yml, so running deploy from local will need to set this .env variable to enable error tracking on that deployment.

Helpful Links

• React Player, used to interface with Youtube
• Youtube IFrame Player API, used to control some features of the Youtube player