Ballerine Installation Guide

Prerequisites

Before you can install and use Ballerine, you will need the following:

Install prerequisites

• Node.js (Minimum version 18) (you can install node via NVM: Install NVM)
• Latest PNPM version (Minimum version 8.0) (Install PNPM)
• Docker and docker compose (Docker, Docker Compose)

Installation Steps

1. Clone the project: Use Git to clone the Ballerine repository to your local machine:

git clone https://github.com/ballerine-io/ballerine.git && cd ballerine

2. Switch to the dev branch: After cloning, switch to the development branch:

git checkout dev

3. Install dependencies: Use pnpm to install all the required dependencies:

pnpm install

npm install

yarn install

4. Initialize the monorepo: The project is set up as a monorepo. Initialize it using the following command:

pnpm run monorepo:init

npm run monorepo:init

yarn run monorepo:init

Run one of the examples, or follow a guide from the guide sections

Start the KYB example: To start the example flow, use the following command:

pnpm run kyb-manual-review-example

npm run kyb-manual-review-example

yarn run kyb-manual-review-example

After performing these steps, the backoffice should be running on http://localhost:5137/, the collection flow on http://localhost:5201/ and the workflow service will be accepting calls at http://localhost:3000/.

The default username and password for the backoffice are:

Username:

admin@admin.com

Password:

admin