Skip to content

overview getting started

khanhthanhdev edited this page Jun 2, 2026 · 1 revision

Getting started

Prerequisites

  • Bun (package manager and runtime)
  • PostgreSQL database (or Neon account)
  • Qdrant vector database
  • Infinity embedding server (for local embeddings)

Optional services for full functionality:

  • AWS S3 bucket for image storage
  • Firecrawl API key for web scraping
  • Resend API key for emails
  • ScreenshotOne API key for tool screenshots
  • Google Gemini API key for AI features

Installation

# Clone the repository
git clone https://github.com/khanhthanhdev/aikc.git
cd aikc

# Install dependencies
bun install

# Copy environment template
cp .env.example .env
# Edit .env with your configuration

Environment variables

See .env.example for the full list. Key variables:

Variable Description
DATABASE_URL PostgreSQL connection string
DATABASE_URL_UNPOOLED Direct (non-pooled) PostgreSQL URL
QDRANT_URL Qdrant server URL
QDRANT_API_KEY Qdrant API key
INFINITY_EMBEDDING_URL Infinity embedding server URL
INFINITY_EMBEDDING_MODEL Embedding model name
INFINITY_EMBEDDING_DIMENSIONS Embedding dimensions (384 for MiniLM)
AUTH_SECRET NextAuth.js secret
AUTH_GOOGLE_ID / AUTH_GOOGLE_SECRET Google OAuth credentials
OPENAI_API_KEY OpenAI API key
GEMINI_API_KEY Google Gemini API key
S3_BUCKET, S3_REGION, S3_ACCESS_KEY, S3_SECRET_ACCESS_KEY AWS S3 config
FIRECRAWL_API_KEY Firecrawl web scraping
RESEND_API_KEY Email sending
SCREENSHOTONE_ACCESS_KEY Screenshot capture
RAG_ENABLED Enable/disable RAG features (true/false)

Database setup

# Generate Prisma client
bun run db:generate

# Push schema to database (no migration files)
bun run db:push

# Open Prisma Studio (optional GUI)
bun run db:studio

The schema uses PostgreSQL extensions citext (case-insensitive text) and pg_trgm (trigram search). These are enabled automatically by Prisma.

Vector database setup

# Initialize Qdrant collections
bun run qdrant:setup

# Force recreate collections (destructive)
bun run qdrant:reset

# Test search functionality
bun run qdrant:test

# Check for schema drift
bun run qdrant:drift

Running locally

# Development server (port 5175)
bun run dev

# Production build
bun run build

# Start production server
bun run start

Docker Compose

For a full local stack with all services:

# Start all services
docker compose up -d --build

# Run Qdrant setup
docker compose --profile setup up qdrant-setup

# View logs
docker compose logs -f app

The Docker Compose setup includes PostgreSQL, Qdrant, Infinity embeddings, Inngest, Caddy reverse proxy, and PostgREST.

Code quality

# Lint and fix
bun run lint

# Format code
bun run format

# Run Biome check (lint + format)
bun run check

# Generate SVG sprite from icons
bun run icons

Data import

# Import AI study tools data
bun run import:ai-tools

# Populate related tools relationships
bun run related-tools:populate

Clone this wiki locally