Skip to main content

🛠️ Developer Setup & Onboarding

Welcome to the team! Complete these steps before picking up your first ticket.

1. Required Software​

Ensure you have the following installed on your machine:

  • Node.js (v18 or higher)
  • Git
  • Docker Desktop (for running local PostgreSQL/MongoDB containers)
  • Android Studio (Required for Kotlin developers and React Native Android testing)
  • VS Code (Recommended IDE) with extensions: ESLint, Prettier, Prisma (if backend).

2. Environment Variables (.env)​

Never commit API keys.

  1. Clone your assigned repository.
  2. Copy .env.example to a new file named .env.
  3. Request the development API keys (Razorpay test keys, Firebase configs) from the Project Manager via secure chat.

3. Local Database Setup (Backend Devs)​

We use Docker to standardize the database setup.

  1. Navigate to the khanaa-api-core repository.
  2. Run docker-compose up -d to spin up local instances of PostgreSQL, MongoDB, and Redis.
  3. Run npm run db:migrate to push the schema to your local database.