A multiplayer, realtime application based on the rules of the board game Codenames. The project aims to follow a microservice based architecture while maintaining vendor neutrality. It also makes use of cloud native technologies (see CNCF Landscape).
This project is a way for me to experiment, evaluate, and demo new technologies. If you find a bug, spot an optimization, encounter a bad practice, or simply want to point out something unidiomatic, please open an issue before raising a pull request.
Running inside a Development Container (see .devcontainer)
- VSCode or the Dev Container CLI
- Docker
- Docker
- A local Kubernetes environment v1.27+ or v1.23+ with feature flag GRPCContainerProbe
- Helm
- Skaffold
- ko for building Go containers without docker
- (Optional) Pack for Cloud Native Buildpacks
- (Optional) Languages to run applications natively (see architecture table below)
| Service | Language / Framework | Notes |
|---|---|---|
| Games | Go / gRPC | Handles game logic, stores state in Redis and publishes updates to NATS |
| Games BFF | TypeScript / Express | ts-rest, Node.js, subscribes to NATS and streams game updates to players in real time with websockets |
| Games SPA | TypeScript / React | Game frontend build with Vite, Material UI, React Hook Form, axios, and hosted via NGINX |
| Lobbies | C# / ASP.NET | Uses SignalR with a Redis backplane to stream updates to the SPA |
| Lobbies SPA | TypeScript / Angular | Built with Angular Material and tailwindcss, allows players to select their team |
| Players | Python / FastAPI | Handles player state with Redis, hosted via uvicorn |
| Players SPA | TypeScript / React | Allows players to set and update their nickname, built with formik hosted via NGINX |
| Words | Go / gRPC | Provides different word lists to vary games |
minikube start --profile codenames
skaffold config set --global local-cluster true
eval $(minikube -p codenames docker-env)Current dependencies are:
helm repo add bitnami https://charts.bitnami.com/bitnami
helm repo add nats https://nats-io.github.io/k8s/helm/charts/
helm repo update
helm install envoy-gateway oci://docker.io/envoyproxy/gateway-helm --version v1.0.1 -n envoy-gateway-system --create-namespace
helm install nats nats/nats
helm install games-redis bitnami/redis --set architecture=standalone
helm install lobbies-redis bitnami/redis --set architecture=standalone
helm install players-redis bitnami/redis --set architecture=standaloneskaffold devkubectl exec -n default -it my-nats-box -- /bin/sh -l
nats-sub <subject>