You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/quickstart.md
+41-4Lines changed: 41 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,12 @@ tags: [quickstart]
7
7
8
8
# 🚀 Quickstart
9
9
10
+
## Prerequisites
11
+
12
+
- Node >= 18 (tested on 20+)
13
+
- pnpm >= 7 (install via `npm install -g pnpm`)
14
+
- Bun (optional, but speeds up the dev server — install via `curl -fsSL https://bun.sh/install | bash`)
15
+
10
16
Follow these steps to run the **Hypergraph monorepo** on your machine.
11
17
12
18
## 1. Clone the repository
@@ -27,7 +33,23 @@ cp .env.example .env
27
33
pnpm prisma migrate dev
28
34
```
29
35
30
-
## 3. Development
36
+
## 3. Build workspace packages
37
+
38
+
Before you run *any* app you must compile the TypeScript workspaces so their `dist/` folders exist:
39
+
40
+
```bash
41
+
pnpm build # one-off build of every package (hypergraph-react, hypergraph, …)
42
+
```
43
+
44
+
> Pro-tip: while iterating on library code you can use the watch script instead of running a full build each time:
45
+
>
46
+
> ```bash
47
+
> pnpm --filter @graphprotocol/hypergraph-react dev # tsc -w
48
+
>```
49
+
50
+
After the initial build you can keep a watcher running or rely on the one we start in the next section.
51
+
52
+
## 4. Development
31
53
32
54
Start a watcher to rebuild packages on change:
33
55
@@ -54,7 +76,7 @@ cd apps/server
54
76
pnpm prisma migrate dev
55
77
```
56
78
57
-
## 4. Run the Next.js example
79
+
## 5. Run the Next.js example
58
80
59
81
Ensure packages are built, then:
60
82
@@ -65,7 +87,16 @@ pnpm dev
65
87
66
88
Visit `http://localhost:3000` to see the example app in action.
67
89
68
-
## 5. Upgrade dependencies
90
+
> 💡 **Optional:** If you'd rather skip the `pnpm build --watch` process while hacking on `packages/hypergraph-react`, add the package to `transpilePackages` in `apps/next-example/next.config.ts`:
0 commit comments