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

# Configure Setup Workflow

## Overview

Before creating projects in the Engineering Metrics platform, users must first configure one or more integrations. Integrations act as the primary data sources used to collect engineering, CI/CD, repository, deployment, and AI usage metrics.

Projects depend on configured integrations to synchronize and process analytics data. Without a valid integration connection, project synchronization and dashboard reporting will not function correctly.

This section explains the recommended setup workflow and prerequisites required before project creation.

## Recommended Setup Workflow

To successfully configure Engineering Metrics, follow the steps below in order:

### 1. Create a Project

Create a project to define what you want to track and organize your engineering analytics. Give the project a meaningful name and select the appropriate project type.

### 2. Connect Your Data Source

From within the project, create a new integration connection or reuse an existing one. Authenticate the supported provider, such as GitHub, GitLab, Bitbucket, Jenkins, CircleCI, OpenAI, Anthropic, Cursor, or another supported platform.

### 3. Select What to Sync

Choose the repositories, pipelines, projects, accounts, or other supported data sources that should be synchronized into the project.

### 4. Set the Sync Schedule

Configure how often data should be synchronized, how much historical data should be imported, and any additional synchronization settings.

### 5. Run the First Sync

Start the initial synchronization to begin importing and processing data from the connected integration.

### 6. View Your Dashboard

After the synchronization completes successfully, your dashboards will begin displaying Engineering Metrics, DORA Metrics, Pull Request analytics, CI/CD insights, AI Coding metrics, LLM metrics, and other available analytics based on your connected integrations.

## General Prerequisites

Before configuring integrations, ensure the following requirements are met:

* Access to the Engineering Metrics platform
* Permissions to configure integrations and projects
* Valid credentials or API tokens for the external provider
* Required repository, pipeline, or API access permissions
* Network connectivity between Engineering Metrics and the external platform
* Proxy configuration details if operating within a restricted enterprise environment

## Authentication and API Tokens

Most integrations require API-based authentication using one of the following:

* Personal Access Tokens (PATs)
* API Keys
* OAuth Tokens
* Admin Keys
* Service Account Credentials

For each integration provider, users should:

* Generate the required token or API key
* Ensure the token has the necessary access scopes and permissions
* Store credentials securely
* Avoid using personal user credentials where possible
* Prefer dedicated service or organization-managed accounts for production environments

Detailed token generation steps and required scopes are documented within each integration section of this guide.

## Important Notes

* A project cannot synchronize data until at least one valid integration connection is configured
* Insufficient permissions or incorrect token scopes may result in missing repositories, failed synchronization, or incomplete analytics
* Some integrations may support only one active connection per organization depending on provider limitations
* Synchronization schedules and historical data ranges directly impact dashboard visibility and reporting accuracy