An OBS browser source overlay that will show which players are currently playing and what the score is.
-
Clone the repo.
git clone github.com/codephobia/pool-overlay.git -
Go to new directory.
cd pool-overlay -
Install dependencies.
Note: We are currently using the Pro version of FontAwesome so we need to include the token as an environment variable (FONTAWESOME_NPM_AUTH_TOKEN) which is read from the
.npmrcfile during install. You can get the token from your FontAwesome account settings. Docker will add the environment variable as a build arg through docker compose.npm install -
Launch application.
docker compose up
The following applications exist in the Nx monorepo:
| Name | Description | Readme |
|---|---|---|
| Api | The REST API and Websocket connections used by the Overlay. | README |
| Seed | Seeds the database with some basic information. | README |
| Overlay | An Angular application that displays the scoreboard in OBS. | README |
The following libraries exist in the Nx monorepo:
| Name | Description | Readme |
|---|---|---|
| go | Contains all internal packages for the api and seed apps. | README |
Everything is setup to run with docker containers and docker compose. The following services exist:
| Name | Description | Ports | Dockerfile |
|---|---|---|---|
| db | The postgres database storing all player and game information. | 5432 | |
| db-admin | An admin interface for the database using pgadmin. | 5050 | |
| api | The REST API and Websocket connections used by the Overlay. | 1268 | Dockerfile |
| overlay | An Angular application that displays the scoreboard in OBS. | 4200 | Dockerfile |
Github actions are setup on the repo to test linting.
Lints the following:
- Go
- Angular