Skip to Content

Installation

This repo is a monorepo with:

  • Docs: client/docs
  • Game client: client/game
  • Servers: server/*
  • Shared packages: shared/*
  • Gno: sub-modules/gno/ and contracts/

Prerequisites

  • Docker Desktop (required for Devcontainer + Compose)
  • VS Code + Dev Containers extension
  • Git

You do not need to install Node, pnpm, or Go locally when using the Devcontainer. The container image includes them.

Open in Devcontainer

  1. Open the repository in VS Code.
  2. Run Dev Containers: Reopen in Container.

If you are using VS Code, the Dev Containers extension is the recommended way to run the dev environment.

The Devcontainer builds the akkadia-devcontainer image and mounts the workspace at /workspaces/akkadia.

What happens on first open

The Devcontainer runs:

sh ./bin/docker/init-env.sh docker compose --profile dev up -d
  • init-env.sh creates/updates .env with UID/GID defaults (Mac: 501/20)
  • The dev profile starts the devcontainer service for a persistent shell

Optional: override UID/GID

If you need to override user IDs, edit .env:

UID=501 GID=20

Local / staging / prod

  • Local: run the stack (or parts of it) via Docker Compose
  • Staging: integration testing / QA environment
  • Prod: production environment

Each service repo expects its own .env.development file when running locally.

Helper scripts live under bin/, with Docker helpers in bin/docker/* and Gno helpers in bin/gno/*.

Last updated on
Docsv1.0.10