This repository is a zKshatriya game app chain development using the Protokit framework.
The monorepo contains 1 package and 1 app:
packages/chain
contains everything related to your app-chainapps/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
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
# starts both UI and sequencer locally
pnpm dev
# starts UI only
pnpm dev -- --filter web
# starts sequencer only
pnpm dev -- --filter chain
# 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.