Configuring Your Development Environment

Getting Started

This document outlines the standard procedure for setting up your local environment to contribute to the IARAP platform. We use a Turborepo-powered monorepo, requiring specific tooling versions to ensure build consistency.

Required Tools

Before cloning the repository, ensure you have the following installed:

• Node.js: v20.x or higher (We recommend using nvm or fnm to manage versions).
• pnpm: v9.x (We strictly use pnpm; do not use npm or yarn as they will ignore our lockfile).
• Docker Desktop: Required for running the local PostgreSQL database and Redis instances.

Step 1: Clone and Install

Clone the repository and install dependencies from the root:

git clone https://github.com/iarap/iarap-platform.git
cd iarap-platform
pnpm install

Step 2: Environment Variables

Copy the example environment files. You will need to request the development secrets (like Razorpay test keys and OAuth client secrets) from your team lead.

cp .env.example .env
cp apps/web/.env.example apps/web/.env.local

Step 3: Database Setup

Start the local Docker containers:

docker-compose up -d

Once Postgres is running, push the schema and seed the initial data:

pnpm --filter @iarap/database db:push
pnpm --filter @iarap/database db:seed

Step 4: Run the Development Server

Start the Turborepo development task from the root directory:

pnpm dev

The web application will be available at http://localhost:3000.

Troubleshooting

• Port Conflicts: If Postgres fails to start, ensure you don't have a local Postgres instance running on port 5432.
• Prisma/Drizzle Errors: If you pull new code that includes schema changes, always re-run pnpm --filter @iarap/database db:push.