PubKey Bot

Getting Started

Prerequisites

• Node v18 or higher
• Yarn
• Docker

Installation

Clone the repo and install dependencies:

git clone git@github.com:pubkeyapp/pubkey-bot.git
cd pubkey-bot
yarn

Automatic setup

You can run the automatic setup script to create the .env file, test the setup and push the database schema.

yarn setup

Environment variables

Copy the .env.example file to .env and fill in the missing values.

cp .env.example .env

Starting the services

You will need to start the database before starting the backend.

yarn dev:services

Pushing the database schema

If you start from scratch, you will need to push the database schema to the database.

yarn prisma db push

Also, after each change to the schema in prisma/schema.prisma, you will need to run the above command again.

Starting the API

yarn dev:api

Starting the web ui

yarn dev:web

Starting the SDK generator

yarn dev:sdk