Skip to content

Quick Start

Get PockerDeck running in under two minutes.

Prerequisites

  • Docker 22+ (or Docker Desktop)
  • Docker Compose v2 (included with Docker Desktop and newer Docker Engine installs)

1. Clone the repository

git clone https://github.com/byteavanta/pockerdeck.git
cd pockerdeck

2. Start the app

docker compose up -d --build

3. Open the app

Open http://localhost:8000 in your browser.

Tip

The -d flag runs the container in the background. Remove it if you want to see live logs.

Option B — Pre-built image from Docker Hub

If you just want to run it without cloning the source:

docker run -d -p 8000:8000 --restart unless-stopped ceco556/pockerdeck:latest

Visit http://localhost:8000.

Option C — Python (no Docker)

Suitable for local development or testing without Docker.

1. Clone and enter the repo

git clone https://github.com/byteavanta/pockerdeck.git
cd pockerdeck

2. Install dependencies

pip install -r requirements.txt

3. Run the dev server

cd app
uvicorn main:app --reload

The app is available at http://localhost:8000.

Warning

The --reload flag is for development only. Do not use it in production.

Verify everything is running

After starting the app, create your first room:

  1. Open http://localhost:8000.
  2. Click + Create Room.
  3. Enter your display name and you're ready to go.

Next steps