Quick Start

Get FeedbackAI running in 5 steps

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

Step 1: Prerequisites and Setup

Clone the repository

git clone https://github.com/your-org/feedback-ai.git
cd feedback-ai

Install dependencies

Ensure you have Node.js 18+ installed, then run:

npm install

Also install ngrok globally for webhook development: npm install -g ngrok

Step 2: Environment Configuration

Create .env file

Create a .env file in the root directory:

# 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"

Setup Database

Initialize your database with Prisma:

npx prisma generate
npx prisma db push

Make sure your MongoDB connection string is valid before running these commands.

Step 3: Development Setup

Setup Webhooks (Development)

For webhook functionality during development:

# 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

Start Development Server

npm run dev

Open http://localhost:3000 to see FeedbackAI running!

Step 4: Create Your First Admin User

Setup Admin Account

Sign up through the authentication flow at /auth
Your first user will need to be manually assigned admin role in the database
Or use the included database seed script if available

Step 5: Start Creating Content

Create Your First Assessment

Navigate to the admin dashboard
Create question sets with mixed question types
Assign tests to candidates
Monitor results and AI evaluations in real-time

Next Steps

Now that FeedbackAI is running, explore these key features:

Mixed Questions

Learn how to create tests with both coding and short answer questions.

AI Interviews

Set up voice-enabled AI interviews with speech processing.

Role Management

Configure Admin, Interviewer, and Candidate permissions.

API Integration

Integrate with the FeedbackAI REST API.

Production Deployment

Ready to deploy? Check out these guides:

Vercel Deployment

Deploy to Vercel with one click.

Environment Setup

Configure production environment variables.

Need help? Check our architecture documentation or API reference.

Getting started

Core Features

Architecture

Development Tools

Get FeedbackAI running in 5 steps

Step 1: Prerequisites and Setup

Step 2: Environment Configuration

Step 3: Development Setup

Step 4: Create Your First Admin User

Step 5: Start Creating Content

Next Steps

Mixed Questions

AI Interviews

Role Management

API Integration

Production Deployment

Vercel Deployment

Environment Setup

​Get FeedbackAI running in 5 steps

​Step 1: Prerequisites and Setup

​Step 2: Environment Configuration

​Step 3: Development Setup

​Step 4: Create Your First Admin User

​Step 5: Start Creating Content

​Next Steps

Mixed Questions

AI Interviews

Role Management

API Integration

​Production Deployment

Vercel Deployment

Environment Setup

Get FeedbackAI running in 5 steps

Step 1: Prerequisites and Setup

Step 2: Environment Configuration

Step 3: Development Setup

Step 4: Create Your First Admin User

Step 5: Start Creating Content

Next Steps

Production Deployment