ewerx/zksync-starter

⚡ A monorepo starter kit for building zkSync apps

zkSync Turborepo Starter

A zkSync + Next.js Turborepo starter kit to quickly ship L2 Web3 apps.

What's inside?

Apps

• web: a Next.js app with:
  • zkSync Web3 SDK
  • wagmi
  • RainbowKit
  • ethers.js
• contracts: a Hardhat project with:
  • zkSync Hardhat plugins
  • TypeChain
  • chai/mocha for testing

Packages

• generated: for sharing smart contract artifacts
• eslint-config-custom: eslint configurations (includes eslint-config-next and eslint-config-prettier)
• tsconfig: shared config
• tailwind-config: tailwind.config.js: shared config

Developer Experience

• TypeScript
• pnpm
• ESLint
• Prettier
• TailwindCSS
• Typechain

Get Started

Install pnpm if you don't have it already:

npm install -g pnpm

Install dependencies:

cd zksync-starter
pnpm install

Start the web app:

turbo dev

ℹ️ You can run commands in the root of the repo or in any of the apps or packages. See turbo.json for monorepo configuration. pnpm run to see available commands.

Contract Development

Start Local Network

Requires Docker. See https://github.com/matter-labs/local-setup for more info.

turbo node

The initial setup takes a while and should not be interrupted

Compile

turbo compile

Test

turbo test

Deploy

Edit apps/contracts/hardhat.config.ts to set RPC URL and deployer private key.

turbo deploy

Resources

This starter kit is based on:

• create-web3-turbo
• zkSync Quickstart Tutorial

zkSync

• https://era.zksync.io/docs/