About this project
surreal_ck is a web-only collaborative spreadsheet project. Its architecture combines a backend server built with Bun and Hono, a Svelte-based web frontend, and a shared package containing the DTOs and schemas used by both sides. Data is stored in SurrealDB, which the server accesses over WebSocket (WSS).
The repository is organized as a monorepo split into three directories: `server/` for the backend, `web/` for the frontend, and `shared/` for the common DTO/schema package. Historical desktop code is retained under `server/legacy/` and `web/legacy/` while the project continues its migration to a web-only model.
For local development, the project uses pnpm workspaces: install dependencies with `pnpm install`, copy `.env.example` to `.env`, run type checking across all packages with `pnpm -r run typecheck`, and start the server in development mode with `pnpm --filter @surreal-ck/server dev`. The server exposes a health endpoint at `http://localhost:8080/health`, which can be verified with curl.
Docker deployment is also supported: running `docker compose up --build` starts the stack, after which the same health endpoint can be used to confirm the server is up and responding.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.