jakebluhm / omo

URL: https://omo.social/

# Steps to build and run locally

Clone this repo

Check if you have node by running "node -v" in terminal

Download node if you dont have it, I used Chocolaty to download node

run "npm install" inside local repo

run "npm start" inside local repo to run server code

cd client

run "npm start" again to run website code

Should open browser window

Lightsail details

Public static IP address This static IP is available for public connection worldwide.

3.136.49.106 Attach to an instance Attaching a static IP replaces that instance's dynamic IP address.

OMOServer

Detach 512 MB RAM, 1 vCPU, 20 GB SSD

Build in lightsail

NODE_OPTIONS="--max-old-space-size=4096" npm run build

or

cd htdocs/OMO
./deploy

Tests

Selenium launches 3 browsers and attempts to connect the 3 users confirming the operation of aws

OMOUserAdded Lambda matchmaking function test

omo's Issues

Set up TURN Server

Most feasible way to test is quality error reporting, set up something where any uncaught errors, un rendered video, is sent to a place where I can view in meaningful way

ios mute/volume fix

Ice breakers associated with each prompt, that show throughout the game

Simulate several users with tools like Artillery or Apache JMeter

Add a way to return to home when in game

Need to end game if the odd man out leaves?

Database format thread

Keep up to database organization here.

Root
List of prompts
Prompt 1
String for question
Strings for possible answers to question
WebRTC data to allow others to join (Still an unknown on how exactly this works)
Number of current players in room?
...
...

Automatic language detection?

Set up style plugin and CI/CD

Add unmute button for platforms that need to start video as muted

When page is refreshed while in game it appears like a new user is joining

Find a way to make sure refresh doesn't add new user.

Catch the error when a user just visits a random room for example omo.social/room/-random-uuid- and display a page maybe?

After a redirect after a completed game, the next game struggles to connect the users. Debug and fix.

When joining a room display prompt and require answer for entry

This might lead to some confusion because there needs to be a way to make sure there is an odd man out in the room.

Select database and implement simple read/write functions

Read and write should be done in useEffect() becuase they are side effects (basically a async callback for when a state variable chage)

First few sections of this article explain this clearly:
https://dmitripavlutin.com/react-useeffect-explanation/

Figure out a way to modify the simple peer index.js in client not modules to always exclude the udp extension

Investigate light weight NN for video processing, like facial recognition to display a static image of the player during the vote

See if its possible to freeze video once the timer expires and that'll serve as a picture that displays next to the players name on the vote screen

Run lambda function when user is added to OMOUserQueue dynamodb - Needed for matchmaking algo

Create first iteration of matchmaking algorithm in the lambda function

Remove user entry from AWS DynamoDB on exiting client

Create barebones version of the game: Prompt Heading, Timer, Vote, Retry, Redirect

Figure out server stuff

figure out the best way to host the database and make it work in the code

Add read/write for Prompts

Write: UI process where a user can create a prompt ending with a database write

Read: On initial load of page pull latest prompts from database. Potentially add listener for when new ones are added and user already has page open.

Not working on Google Chrome for iOS, or Safari for Mac

Lightsail will go down after a while need to make sure that server.js can reliably run 24/7

Set up test environment CI/CD

Currently oddOneOut which is a param into Room.js is hardcoded to true, the lambda that sends room uuid needs to let clients know the prompt ID that was selected to display question in room, and for Room.js to 'know' who is OMO

Is there a way to find a recommended internet speed that is required, can I simulate lower internet speed, if I can find a minium required internet speed can I warn users who do not meet the requirement or restrict their access?

It seems like it would be possible to connect a user to a simulated peer to figure out if the current user requires a TURN server, which I could then restrict their access.

Host the Server with a web hosting service - Needed before implementing matchmaking

If a user leaves the game logic should be voided. Vote canceled, OMO revealed, maintain videoGrid component with message saying "name" Left. etc

Code cleanup

Once a match is found the lambda should communicate the unique URL to each of the users

Relinquish camera access before redirect

Simple UI UX

Debug issues with mobile

Check a person has a camera and mic in CreateRoom.js

Failed connections indefinitely hang up, need to begin next search after a timeout

Once a game is complete the user should automatically be re-entered into the queue, with a manual button to go back to main page

Create a DynamoDB table for prompt list, clients should be served the prompts in table

receiving returned signal occurs when users video is displayed add state to wait to render game untill peersRef is ready

All Server.js communication should have RoomID parameter

Seems like someone can copy their url to a player not in the game and they could join this should not be allowed - Maybe a check for valid userID