n8ventures / Roe2

Remote Overlay Environment, an overlay tool made for tournaments hosted on acadarena platform

Roe2

Remote Overlay Environment 2

An overlay tool for tournaments hosted in AcadArena platform.

What's inside?

This turborepo uses Yarn as a package manager. It includes the following packages/apps:

Apps and Packages

• ctrl: Console for Remote Overlay Tool
• overlay: Web based stream overlay
• ws: Websocket server
• cloud-functions: Cloud Functions for Firebase
• utils: utilities that can be used through all of the apps
• ui: a stub React component library shared by both ctrl and overlay applications
• config: configurations (includes vite.config.js eslint-config-next and eslint-config-prettier)
• tsconfig: tsconfig.jsons used throughout the monorepo
• interface: typescript types and interfaces

Setup

This repo requires Yarn as a package manager. Run this command to install yarn

npm install --global yarn

Build

To build you must have the same node version or higher. To build all apps and packages, run the following command:

yarn run build

Develop

To develop all apps and packages, run the following command:

yarn run dev