From 412382f74edd9523539c1d05fc01361e737146eb Mon Sep 17 00:00:00 2001
From: Sarah Schwartz <58856580+sarahschwartz@users.noreply.github.com>
Date: Sat, 21 Dec 2024 13:47:34 -0700
Subject: [PATCH] docs: update readme with local dev instructions (#43)

* docs: update readme with local dev instructions

* fix: lint

* docs: cleanup
---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/README.md b/README.md
index f18da20..832045b 100644
--- a/README.md
+++ b/README.md
@@ -125,6 +125,32 @@ This monorepo is comprised of the following packages, products, and examples:
    [workspace protocol](https://pnpm.io/workspaces#workspace-protocol-workspace)
    to link SDK in the new folder.
 
+3. Start a local node:
+
+   ```bash
+   npx zksync-cli dev start
+   ```
+
+4. Compile and deploy contracts to the local node:
+
+   ```bash
+   # Compile and deploy contracts
+   cd packages/contracts
+   pnpm build
+   pnpm run deploy
+   ```
+
+5. Start the demo application:
+
+   ```bash
+   # Go back to root folder to start demo app
+   cd ../..
+   pnpm nx dev demo-app
+   ```
+
+Your local Auth Server will be running at `http://localhost:3002/`, and the demo
+app will be running at `http://localhost:3004/`.
+
 ## Running commands
 
 Use the NX CLI to run project commands, however PNPM is still usable as an