Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/publish-images.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Publish images to GHCR
name: Publish Images to GHCR

# Builds the production images the homelab cluster runs:
# ghcr.io/mateuseap/chesskernel-server
Expand Down
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,30 @@ Chess platforms today lock features behind subscriptions, harvest your game data
| 🌍 **Multilingual** | English, Portuguese, and Spanish |
| 🐳 **Docker-first** | One command to run the entire stack |

## Architecture

A React client served by nginx, which reverse-proxies the API and the realtime socket to a NestJS server. The server holds authoritative game state, drives Stockfish for analysis and bots, persists to PostgreSQL, and uses Redis for caching and pub/sub.

```mermaid
flowchart LR
browser(["browser: React client"])
nginx["nginx<br/>static assets + /api and /socket.io proxy"]
server["NestJS server :3001<br/>authoritative games, Socket.IO"]
stockfish["Stockfish<br/>analysis and bots"]
postgres[("PostgreSQL<br/>users, games, ratings")]
redis[("Redis<br/>cache + pub/sub")]

browser -->|HTTPS static| nginx
browser <-->|/api REST| nginx
browser <-->|/socket.io WebSocket| nginx
nginx <--> server
server --> stockfish
server --> postgres
server --> redis
```

Moves are validated server-side with chess.js; ratings use Glicko-2. See [docs/architecture](docs/architecture/overview.md) and [docs/backend](docs/backend/backend-architecture.md) for the full design.

## Quick Start

```bash
Expand Down
Loading