Skip to content

Commit af064e0

Browse files
committed
enhance quickstart guide with prerequisites and build instructions for improved clarity
1 parent 62bb21d commit af064e0

File tree

1 file changed

+41
-4
lines changed

1 file changed

+41
-4
lines changed

docs/docs/quickstart.md

Lines changed: 41 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@ tags: [quickstart]
77

88
# 🚀 Quickstart
99

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+
1016
Follow these steps to run the **Hypergraph monorepo** on your machine.
1117

1218
## 1. Clone the repository
@@ -27,7 +33,23 @@ cp .env.example .env
2733
pnpm prisma migrate dev
2834
```
2935

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
3153
3254
Start a watcher to rebuild packages on change:
3355
@@ -54,7 +76,7 @@ cd apps/server
5476
pnpm prisma migrate dev
5577
```
5678

57-
## 4. Run the Next.js example
79+
## 5. Run the Next.js example
5880

5981
Ensure packages are built, then:
6082

@@ -65,7 +87,16 @@ pnpm dev
6587

6688
Visit `http://localhost:3000` to see the example app in action.
6789

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`:
91+
>
92+
> ```ts title="apps/next-example/next.config.ts"
93+
> const nextConfig = {
94+
> transpilePackages: ['@graphprotocol/hypergraph-react'],
95+
> };
96+
> export default nextConfig;
97+
> ```
98+
99+
## 6. Upgrade dependencies
69100
70101
Keep everything up to date with:
71102
@@ -77,4 +108,10 @@ pnpm up --interactive --latest -r
77108

78109
### Edit on GitHub :bust_in_silhouette:
79110

80-
[✏️ Improve this page](https://github.com/graphprotocol/hypergraph/edit/main/docs/docs/quickstart.md)
111+
[✏️ Improve this page](https://github.com/graphprotocol/hypergraph/edit/main/docs/docs/quickstart.md)
112+
113+
114+
115+
116+
117+
```

0 commit comments

Comments
 (0)