Setup Guide

Get Codity running locally in under 10 minutes. This guide covers installation, environment setup, provider connection, and your first review run.

Prerequisites

  • Node.js 20 or newer
  • npm 10 or newer
  • Git installed locally
  • Access to GitHub, GitLab, or Azure DevOps
  • Admin access to at least one repository

Step 1: Install Dependencies

Clone the project and install dependencies.

git clone https://github.com/your-org/codity-webapp.git
cd codity-webapp
npm install

Step 2: Configure Environment Variables

Create your local environment file.

cp .env.example .env.local

Add the required values.

# .env.local
NEXT_PUBLIC_API_URL=http://localhost:3001
NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=replace-with-a-random-secret

Step 3: Run the Application

Start the development server.

npm run dev

Open http://localhost:3000 in your browser and confirm the app loads.

Step 4: Connect Your First Repository

  1. Sign in to Codity.
  2. Open provider settings.
  3. Connect GitHub, GitLab, or Azure DevOps.
  4. Enable one repository for automated review.

Step 5: Trigger Your First Review

Create a test pull request to confirm end-to-end setup.

git checkout -b docs/setup-test
echo "setup test" >> setup-test.txt
git add .
git commit -m "chore: setup guide test"
git push origin docs/setup-test

Wait 1 to 3 minutes and verify Codity posts review comments in the pull request.

Verify Setup

  • Repository appears in your dashboard
  • Pull request receives Codity review comments
  • Metrics are visible in analytics views

Next Steps