Round Around

Overview

The goal of this project is to create a multi-person collaborative step sequencer (here is an extremely simple one: https://tonejs.github.io/examples/stepSequencer.html) .

Feature of the sequencer are:

• A Radial paradigm (see https://apps.musedlab.org/groovepizza/?museid=naq8XXgSX&)
• Multi-person live collaboration (e.g. google docs + step sequencer)
• Front-end: React based, with computer browser client first, and mobile with ReactNative next
• Back-end: Firebase, leverage real-time database for all collaborative editing features
• Audio engine: Tone.js
• Synthesis: Sample based
• Graphics: svg.js

Reference:

• Simple radial multi-layer simple sequencer: https://tylerbisson.com/Groove-Pizzeria/
• Another simple implementation: https://github.com/NYUMusEdLab/Accessible-Groove-Pizza

Development

Set Node Version

Please use node v14.17.6 - the latest stable version of node, nvm is an easy way to do this

On OX, install Homebrew if you don't have it:

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Install and select said version of Node:

nvm install 14.17.6
nvm use v14.17.6
node -v // should be 14.17.6

(Optional) Clean Install Modules

yarn install --frozen-lockfile`

Local development

• Go to your local branch
• yarn - To install packages that may have changed since your last branch
• yarn build - To do a clean build of js
• yarn start - To start the local server
• navigate to http://localhost:3000

Dev workflow

We use git flow

Summary

• Make sure master is always production ready
• Create feature/bug branches for every issue; put issue ID brance name, e.g. "bug/163-fix-step-count" for Issue #163
• Merge feature branches into stage as soon as it's ready to minimize merge conflicts and lack of transparency in what the code will look like once it's deployed to prod.

Branches

• master - always runs, is deployed to prod (http://rounds.studio and http:/rounds.irl.studio)
• stage - always runs, features are merged to it; is deployed to stage (http://roundaround-stage.web.app) when testing integration of features
• feature/<GitHub-issue-number>-<Feature-Description> - one for each issue labeled as enhancement in github, deployed to dev (http://roundaround-dev.web.app) when testing a feature is useful
• bug//<GitHub-issue-number>-<Bug-Description> - one for each issue labeled as bug, deployed to dev (http://roundaround-dev.web.app) when testing a bug is useful

How is new work added?

• checkout stage and create a new feature/bug branch

• If you want feedback deploy that branch out to roundaround-dev.web.app. It's fine if its buggy at the point of feedback

• When you are confident the new feature is completed make a PR and do a full regression test.

  Deploy to roundaround-dev.web.app. Ask product to test the added functionality. They will not do a regression

• If the tests pass, the PR is approved, and we're happy with the added functionality, merge that branch to stage.

  Deploy to https://roundaround-stage.web.app/

• When we want to merge into master, deploy that (or those) features to the stage server if they aren't already, and everyone does a full regression before we make a PR for stage to master

• If the tests pass we merge to master.

  Deploy to roundaround-dev.web.app

Summary - we never make a branch off master, only stage, and we only ever merge into master after stage is fully regression tested. We try to get feature branches into stage as soon as possible, so we can be confident we're always moving forward building on tested and verified work.

Testing

• As of now there's a git hook to make sure any code committed is linted and doesn't add malformed js
• As of now there's a smoke test that runs locally to make sure the site still loads when pushing

If the smoke test fails you can debug it with: yarn run cypress:open

make sure the site is running locally.

Deploy frontend

• yarn build
• firebase deploy --only hosting:production Should update https://roundaround.web.app/, this should always be master
• firebase deploy --only hosting:stage Should update https://roundaround-stage.web.app/, this should always be develop and be in a stablish state
• firebase deploy --only hosting:dev Should update https://roundaround-dev.web.app/, this can be any branch off develop, it's fine if it's buggy

Deploy functions (generates Jitsi tokens)

• Make sure you have the jaasauth.pk private key file in the root of the functions folder (not kept in git)
• firebase deploy --only functions