Skip to content

Local setup using NPM

Platform API

Clone the platform repository from GitHub:

Terminal window
git clone https://github.com/credebl/platform.git
cd platform

Create a .env file and set the required environment variables as per the .env.sample file.

Install the pnpm package using the following command if it isn’t already installed on your machine:

Terminal window
npm install -g pnpm

Install dependencies

Terminal window
pnpm i

Keep your database schema in sync with your Prisma schema as it evolves and Maintain existing data in your database.

Terminal window
cd libs/prisma-service/
npx prisma migrate deploy

Generate Prisma Client to access schema model with the following command:

Terminal window
npx prisma generate

For initial master table entry create a credebl-master-table.json file at lib/prisma-service/prisma/data and set the required variables as per the credebl-master-table.json file.run following command.

Terminal window
npx prisma db seed

To start the API gateway

Terminal window
pnpm run start

To start all microservices using below command followed by microservice name, example: start user service.

Terminal window
pnpm run start user

Access the Platform API by navigating to:

Terminal window
http://localhost:5000

Using swagger to access platform API

If you’re running docker locally, access the CREDEBL platform swagger dashboard through the API gateway on port 5000.

Terminal window
http://localhost:5000/api

Studio UI

Clone the studio repository:

Terminal window
git clone https://github.com/credebl/studio.git
cd studio

Create a .env file and set the required environment variables as per the .env.sample file.

Install dependencies and start the Studio UI:

Terminal window
npm i
npm run start

Access the Studio UI by navigating to:

Terminal window
http://localhost:3000