> ## Documentation Index
> Fetch the complete documentation index at: https://committ.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start

> Get the CommitT monorepo running locally on your machine.

# CommitT Quick Start

Get your local CommitT development environment running in under 5 minutes.

## Prerequisites

Before starting, ensure you have the following installed:

* **Node.js** (v20+ recommended)
* **Bun** (used as the primary package manager)
* **Android Studio** (for emulator or physical device testing)
* **WSL2** (if running on Windows)

***

## 3-Step Setup

### Step 1: Clone and Install Dependencies

Clone the monorepo and run `bun install` to set up all package dependencies:

```bash theme={null}
git clone https://github.com/Maajith9127/CommitT.git
cd CommitT
bun install
```

### Step 2: Initialize Convex Cloud Backend

CommitT uses **Convex** for real-time mutations and database synchronization. Initialize your Convex development project:

```bash theme={null}
cd packages/backend
npx convex dev
```

This command will:

1. Prompt you to log in or create a Convex account
2. Create a development deployment for your project
3. Automatically write your API keys to `.env.local`

Keep this terminal tab open so the cloud functions auto-deploy as you write code.

### Step 3: Launch React Native (Expo) Dev Server

Open a new terminal tab and launch the Expo development server:

```bash theme={null}
cd apps/native
bun run start
```

Press **`a`** to open the app on an Android emulator or a connected physical device.

***

## Next Steps

Explore the rest of the guides to understand the architecture and native modules:

<CardGroup cols={2}>
  <Card title="Set Up Your Environment" icon="gears" href="/setup-env">
    Configure WSL2 ADB bridging and environment variables.
  </Card>

  <Card title="Start Developing" icon="laptop-code" href="/start-developing">
    Understand the local workflow, logs, and development builds.
  </Card>
</CardGroup>