Skip to content

Installation

This guide gets you from zero to a running local PlayTelly stack.

Prerequisites

  • Docker Desktop installed and running
  • Git access to the Castis GitLab (mashup.castis.io)

1. Create your root folder

All repositories must sit side-by-side in the same parent folder. Quickstart references them by relative path, so the folder names and positions matter.

mkdir playtelly && cd playtelly

2. Clone all repositories

git clone https://mashup.castis.io/playtelly/Quickstart.git
git clone https://mashup.castis.io/playtelly/CoreAPI.git
git clone https://mashup.castis.io/playtelly/AuthAPI.git
git clone https://mashup.castis.io/playtelly/documentation.git

Admin Apps — clone what you need:

# Primary admin app
git clone https://mashup.castis.io/playtelly/AdminApp/PlayoutAdmin.git

# Secondary admin app
git clone https://mashup.castis.io/playtelly/AdminApp/TellyBoard.git

Clone what you use

Not every make target requires all admin apps. Check Make Targets to see which repos a target depends on before cloning.

Your folder should look like this before running any make command:

Roots/
├── Quickstart/
├── CoreAPI/
├── AuthAPI/
├── PlayoutAdmin/      ← if cloned
├── TellyBoard/        ← if cloned
└── documentation/

Folder names must match

Quickstart's Compose files use relative build contexts like ../CoreAPI. If a repo is missing or named differently, Docker Compose will fail to find the build context.

3. Run the stack

cd Quickstart
make base

make base brings up Postgres, NATS, SeaweedFS, tusd, and CoreAPI. Once it's ready you should be able to reach CoreAPI at http://localhost:3000.

For a full list of available targets see Make Targets. Once the stack is running, follow the Walkthrough to verify everything is working.

4. Switching branches

Each repository is independent. If you're working on a feature, branch from staging inside the relevant repo:

cd CoreAPI
git checkout staging
git checkout -b feature/your-feature

You don't need to branch all repos — only the ones you're changing. Quickstart stays on dev for local development.