Environment Setup

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

Prerequisites

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

• Git
• Docker
• Common Sense

Getting Codebase

Git clone the repository using:

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

Setup

API

• Install Golang 1.20 or above
• Install golangci-lint 1.54.0 or above
• Run the following command to finish your API setup

make setup-api

Worker

• Install Python 3.10 or above
• Install pylint 2.17.5 or above
• Run the following command to finish your Worker setup

make setup-worker

Docs

• Install Node 18.10 or above
• Run the following command to finish your Docs setup

make setup-docs

Tests

• Install Python 3.10 or above
• Run the following command to finish your Tests setup

make setup-tests