Skip to main content

Local Development

Learn what you need to run a local Kinetic API

System requirements​

  • Node.js v16.x.x or higher
  • Yarn 1.22.x
  • Docker

Clone repository, install deps​

git clone git@github.com:kin-labs/kinetic.git
cd kinetic
yarn install

Run services​

This wil start Postgres and a local Solana network

yarn dev:services

Setup local environment​

The local setup is configured using the .env file.

In order to get started, copy the .env.example to .env.

You can later adjust the settings there.

cp .env.example .env

After you have set up the environment, you need to initialize the database:

yarn prisma db push

Start API​

Once this is all done, you can start the API:

yarn dev:api

Start Admin​

You can now start the Admin using the following command:

yarn dev:admin

Start Demo​

You can now start the Demo using the following command:

yarn dev:demo