docs: add install + build steps

TylorS · May 23, 2024 · 538ef37 · 538ef37
1 parent 0bc5bdb
commit 538ef37
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/examples/realworld/README.md b/examples/realworld/README.md
@@ -10,6 +10,19 @@ This is a full-stack implementation of the [Realworld Example](https://realworld
 
 ## Getting started
 
+### Build the packages
+
+Because the project is linked up to local packages via `workspace:*`, it is necessary to build the Typed packages before running this example.
+
+```sh
+# Install all dependencies
+pnpm -w install
+# Build all @typed packages
+pnpm -w build
+```
+
+### Running Realworld Example
+
 You'll need two terminals. In the first terminal start the supporting docker containers:
 
 ```sh