Developer Guide

The following guide will help you in setting up the development environment to work on Vitta.

Prerequisites

Make sure, before you start any development, following things are installed and available on your system of choice:

Git clone the repository using:

git clone git@github.com:prabhuomkar/vitta.git

Run the following command to spin up database:

docker compose up -d database # requires golang-migrate to be installed

Run the following command to setup database migrations:

cd api
DATABASE_URL="postgres://vdbuser:vdbpass@localhost:5432/vitta?sslmode=disable" make migrate-up # requires golang-migrate to be installed

Run the following command to run the API server:

cd api
go mod tidy # requires golang to be installed
make run

Run the following command to run the UI:

cd ui
npm install
npm start

Run the following command to setup docs and run it:

cd docs
npm install # requires node.js to be installed
npm run start