Skip to content

docs: document the Sled/Postgres storage flag in the README #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dnorman wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

docs: document the Sled/Postgres storage flag in the README #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,26 @@ A simple real-time chat application built with Ankurah, demonstrating distribute
## Features

- Real-time message synchronization
- Persistent storage (Sled on server, IndexedDB in browser)
- Persistent storage (Sled or Postgres on the server, IndexedDB in browser)
- Automatic user creation with localStorage persistence
- WebSocket-based peer communication
- Reactive UI updates

## Architecture

- **model/** - Shared data models (User, Room, Message)
- **server/** - Rust server with Sled storage and WebSocket connector
- **server/** - Rust server (Sled or Postgres storage) and WebSocket connector
- **wasm-bindings/** - WASM bindings exposing Ankurah to JavaScript
- **react-app/** - React frontend application

## Storage engine

The durable server node stores data in **Sled** by default. Generate the project
with `--define storage=postgres` (or choose Postgres at the prompt) to back it
with **Postgres** instead; the bundled `./dev.sh` then brings up a Postgres
container automatically on a randomized port. Both paths are wired through the
`sled` / `postgres` features in `server/Cargo.toml`.

## Quick Start

### 1. Build and run the server
Expand Down