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

# Quick Start

> Deploy FeedbackAI in minutes and start conducting AI-powered interviews

## Get FeedbackAI running in 5 steps

Set up your FeedbackAI platform locally and start creating interview assessments.

### Step 1: Prerequisites and Setup

<AccordionGroup>
  <Accordion icon="download" title="Clone the repository">
    ```bash theme={null}
    git clone https://github.com/your-org/feedback-ai.git
    cd feedback-ai
    ```
  </Accordion>

  <Accordion icon="tools" title="Install dependencies">
    Ensure you have Node.js 18+ installed, then run:

    ```bash theme={null}
    npm install
    ```

    <Tip>Also install ngrok globally for webhook development: `npm install -g ngrok`</Tip>
  </Accordion>
</AccordionGroup>

### Step 2: Environment Configuration

<AccordionGroup>
  <Accordion icon="key" title="Create .env file">
    Create a `.env` file in the root directory:

    ```bash theme={null}
    # Database
    DATABASE_URL="your_mongodb_connection_string"

    # OpenAI API
    OPENAI_API_KEY="your_openai_api_key"

    # Clerk Authentication  
    CLERK_WEBHOOK_SECRET="your_clerk_webhook_secret"
    NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY="your_clerk_publishable_key"
    CLERK_SECRET_KEY="your_clerk_secret_key"

    # Environment
    NODE_ENV="development"
    NEXT_PUBLIC_API_URL="http://localhost:3000/api"
    ```
  </Accordion>

  <Accordion icon="database" title="Setup Database">
    Initialize your database with Prisma:

    ```bash theme={null}
    npx prisma generate
    npx prisma db push
    ```

    <Tip>Make sure your MongoDB connection string is valid before running these commands.</Tip>
  </Accordion>
</AccordionGroup>

### Step 3: Development Setup

<AccordionGroup>
  <Accordion icon="globe" title="Setup Webhooks (Development)">
    For webhook functionality during development:

    ```bash theme={null}
    # Terminal 1: Start ngrok
    ngrok http 3000

    # Copy the HTTPS URL and update your webhook endpoints:
    # Clerk: https://your-ngrok-url.ngrok.io/api/webhooks/clerk
    ```
  </Accordion>

  <Accordion icon="play" title="Start Development Server">
    ```bash theme={null}
    npm run dev
    ```

    Open [http://localhost:3000](http://localhost:3000) to see FeedbackAI running!
  </Accordion>
</AccordionGroup>

### Step 4: Create Your First Admin User

<Accordion icon="user-plus" title="Setup Admin Account">
  1. Sign up through the authentication flow at `/auth`
  2. Your first user will need to be manually assigned admin role in the database
  3. Or use the included database seed script if available
</Accordion>

### Step 5: Start Creating Content

<Accordion icon="rocket" title="Create Your First Assessment">
  1. Navigate to the admin dashboard
  2. Create question sets with mixed question types
  3. Assign tests to candidates
  4. Monitor results and AI evaluations in real-time
</Accordion>

## Next Steps

Now that FeedbackAI is running, explore these key features:

<CardGroup cols={2}>
  <Card title="Mixed Questions" icon="code" href="/features/mixed-questions">
    Learn how to create tests with both coding and short answer questions.
  </Card>

  <Card title="AI Interviews" icon="microphone" href="/features/ai-interviews">
    Set up voice-enabled AI interviews with speech processing.
  </Card>

  <Card title="Role Management" icon="users" href="/features/role-based-access">
    Configure Admin, Interviewer, and Candidate permissions.
  </Card>

  <Card title="API Integration" icon="terminal" href="/api-reference/introduction">
    Integrate with the FeedbackAI REST API.
  </Card>
</CardGroup>

## Production Deployment

Ready to deploy? Check out these guides:

<CardGroup cols={2}>
  <Card title="Vercel Deployment" icon="cloud" href="/deployment/vercel">
    Deploy to Vercel with one click.
  </Card>

  <Card title="Environment Setup" icon="settings" href="/deployment/environment">
    Configure production environment variables.
  </Card>
</CardGroup>

<Note>
  **Need help?** Check our [architecture documentation](/architecture/overview) or [API reference](/api-reference/introduction).
</Note>
