Skip to content

docs: clarify local dev memory options #5314

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
royalpinto007 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify local dev memory options #5314

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
18 changes: 17 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,23 @@ cd packages/db && bun run db:migrate
bun run dev:full # Starts Next.js app and realtime socket server
```

Or run separately: `bun run dev` (Next.js) and `cd apps/sim && bun run dev:sockets` (realtime).
If your machine is memory-constrained or `dev:full` appears stuck, use the capped or minimal
registry variants:

```bash
bun run dev:full:capped # Caps the Next.js dev server heap at 4GB
bun run dev:full:minimal-registry # Loads the smaller block registry during local development
```

Or run the servers separately in two terminals:

```bash
cd apps/sim && bun run dev # Next.js app
cd apps/realtime && bun run dev # Realtime socket server
```

If the Next.js dev server keeps reusing a bad cache, clear it once with
`cd apps/sim && bun run dev:clean`, then start the dev server again.

## Chat API Keys

Expand Down