Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 1.29 KB

README.md

File metadata and controls

53 lines (37 loc) · 1.29 KB
Raw

Protokit starter-kit

This repository is a monorepo aimed at kickstarting application chain development using the Protokit framework.

Quick start

The monorepo contains 1 package and 1 app:

  • packages/chain contains everything related to your app-chain
  • apps/web contains a demo UI that connects to your locally hosted app-chain sequencer

Prerequisites:

  • Node.js v18
  • pnpm
  • nvm

If you're on windows, please use Docker until we find a more suitable solution to running the @proto-kit/cli. Run the following command and then proceed to "Running the sequencer & UI":

docker run -it --rm -p 3000:3000 -p 8080:8080 -v %cd%:/starter-kit -w /starter-kit gplane/pnpm:node18 bash

Setup

git clone https://github.com/proto-kit/starter-kit my-chain
cd my-chain

# ensures you have the right node.js version
nvm use
pnpm install

Running the sequencer & UI

# starts both UI and sequencer locally
pnpm dev

# starts UI only
pnpm dev -- --filter web
# starts sequencer only
pnpm dev -- --filter chain

Running tests

# run and watch tests for the `chain` package
pnpm run test --filter=chain -- --watchAll

Navigate to localhost:3000 to see the example UI, or to localhost:8080/graphql to see the GQL interface of the locally running sequencer.