Skip to content

Commit

Permalink
docs: update readme with local dev instructions (#43)
Browse files Browse the repository at this point in the history
* docs: update readme with local dev instructions

* fix: lint

* docs: cleanup
  • Loading branch information
sarahschwartz authored Dec 21, 2024
1 parent dda9ebe commit 412382f
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 412382f

Please sign in to comment.