> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/shlokjain2031/email-tracker-extension/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get started with Email Tracker in under 5 minutes

This guide will help you set up Email Tracker and send your first tracked email.

## Prerequisites

Before you begin, make sure you have:

* Node.js installed (v18 or higher recommended)
* Chrome browser
* A Gmail account
* Git installed

## Setup steps

<Steps>
  <Step title="Clone and install dependencies">
    Clone the repository and install all dependencies:

    <CodeGroup>
      ```bash npm theme={null}
      git clone <your-fork-or-repo-url>
      cd email-tracker
      npm install
      ```

      ```bash yarn theme={null}
      git clone <your-fork-or-repo-url>
      cd email-tracker
      yarn install
      ```

      ```bash pnpm theme={null}
      git clone <your-fork-or-repo-url>
      cd email-tracker
      pnpm install
      ```
    </CodeGroup>
  </Step>

  <Step title="Build workspaces">
    Build the shared library and server packages:

    <CodeGroup>
      ```bash npm theme={null}
      npm --workspace=shared run build
      npm --workspace=server run build
      ```

      ```bash yarn theme={null}
      yarn workspace shared build
      yarn workspace server build
      ```

      ```bash pnpm theme={null}
      pnpm --filter shared build
      pnpm --filter server build
      ```
    </CodeGroup>
  </Step>

  <Step title="Start the server">
    Start the tracking server with environment variables:

    <CodeGroup>
      ```bash npm theme={null}
      PORT=8090 DASHBOARD_TOKEN=change-me npm --workspace=server run start
      ```

      ```bash yarn theme={null}
      PORT=8090 DASHBOARD_TOKEN=change-me yarn workspace server start
      ```

      ```bash pnpm theme={null}
      PORT=8090 DASHBOARD_TOKEN=change-me pnpm --filter server start
      ```
    </CodeGroup>

    <Note>
      Replace `change-me` with a strong, random token. This token is required to access your dashboard.
    </Note>

    Verify the server is running:

    ```bash theme={null}
    curl http://localhost:8090/health
    ```
  </Step>

  <Step title="Load the Chrome extension">
    Install the extension in Chrome:

    1. Open Chrome and navigate to `chrome://extensions`
    2. Enable **Developer mode** using the toggle in the top right
    3. Click **Load unpacked**
    4. Select the `extension/` folder from your cloned repository

    <Note>
      The extension icon should now appear in your Chrome toolbar.
    </Note>
  </Step>

  <Step title="Configure the extension">
    Open the extension popup and configure:

    1. Click the Email Tracker extension icon in your toolbar
    2. Set **Tracker Base URL** to `http://localhost:8090` (for local development)
    3. Set **Dashboard Token** to match your `DASHBOARD_TOKEN` from Step 3
    4. Save your settings

    <Warning>
      Both values must match what you configured when starting the server, or tracking will not work.
    </Warning>
  </Step>

  <Step title="Send your first tracked email">
    Test the complete tracking flow:

    1. Go to [Gmail](https://mail.google.com)
    2. Compose a new email message
    3. Enable tracking (the extension will inject the tracking pixel automatically)
    4. Send the email to yourself or another account
    5. Open the email you just sent
    6. Check the dashboard at `http://localhost:8090/dashboard` to see the tracking event

    <Note>
      Opens by the sender (you) are automatically suppressed and won't increment the open count, but will still appear in the dashboard for debugging.
    </Note>
  </Step>
</Steps>

## Next steps

Now that you have Email Tracker running:

* Learn about [installation options](/installation) for production deployments
* Configure [environment variables](/configuration) for your use case
* Set up HTTPS for production email tracking