Skip to content

Commit 5f09ccb

Browse files
docs: replace dashboard template readme
1 parent a65c920 commit 5f09ccb

1 file changed

Lines changed: 30 additions & 22 deletions

File tree

dashboard/README.md

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,44 @@
1-
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
1+
# OpenMemory Dashboard
22

3-
## Getting Started
3+
This app is the optional OpenMemory dashboard UI.
44

5-
First, run the development server:
5+
## What it is
6+
7+
- a separate Next.js app in `dashboard/`
8+
- designed to talk to an OpenMemory backend over HTTP
9+
- not bundled into the bare `packages/openmemory-js` npm install
10+
11+
If you are running OpenMemory without the dashboard, you only need the backend in `packages/openmemory-js`.
12+
13+
## Backend requirement
14+
15+
Start the backend first:
616

717
```bash
18+
cd packages/openmemory-js
19+
npm install
820
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
1521
```
1622

17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
18-
19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
23+
By default the dashboard expects the backend at `http://localhost:8080`.
24+
If you use a different backend URL, configure it in `.env.local` as described in `CHAT_SETUP.md`.
2025

21-
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
26+
## Run the dashboard locally
2227

23-
## Learn More
24-
25-
To learn more about Next.js, take a look at the following resources:
28+
```bash
29+
cd dashboard
30+
npm install
31+
npm run dev
32+
```
2633

27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
34+
Then open <http://localhost:3000>.
2935

30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
36+
## Docker
3137

32-
## Deploy on Vercel
38+
If you want the full local stack, you can also run OpenMemory with Docker and enable the dashboard/UI profile from the repository root.
3339

34-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
40+
## Related docs
3541

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
42+
- `README.md` — top-level project overview
43+
- `dashboard/CHAT_SETUP.md` — dashboard-to-backend setup details
44+
- `packages/openmemory-js/README.md` — backend / SDK docs

0 commit comments

Comments
 (0)