https://github.com/maht0rz/socialcap-protokit

https://github.com/maht0rz/socialcap-protokit

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/maht0rz/socialcap-protokit
• Owner: maht0rz
• Created: 2024-01-12T18:59:39.000Z (12 months ago)
• Default Branch: develop
• Last Pushed: 2024-01-12T19:00:16.000Z (12 months ago)
• Last Synced: 2024-10-08T10:24:18.481Z (3 months ago)
• Language: TypeScript
• Size: 408 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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

```zsh

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

```zsh

# starts both UI and sequencer locally

pnpm dev

# starts UI only

pnpm dev -- --filter web

# starts sequencer only

pnpm dev -- --filter chain

```

### Running tests

```zsh

# 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.