Skip to content

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

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 server storage flag in the README #9

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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,14 @@ const DEFAULT_SERVER_URL: &str = "ws://your-server:9898";

Or pass a custom URL when initializing in `App.tsx`.

### Server storage engine

The server (`ankurah-rn-server`) stores data in **Sled** by default. Generate the
project with `--define storage=postgres` to back it with **Postgres** instead; the
server then reads `DATABASE_URL` (point it at your Postgres). Both are wired through
the `sled` / `postgres` features in `server/Cargo.toml`. This is independent of the
app's on-device storage.

## Running Tests

```bash
Expand Down