Development Preview: Some features may be unstable
Documentation

Setup & Installation

Get Epiclips running locally on your machine in minutes. Use our recommended Docker setup or configure manually with uv.

Prerequisites

  • Python 3.11+
  • Node.js 18+
  • FFmpeg
  • Docker (Recommended)

Option 1: Docker (Recommended)

01.Clone the repository

Start by cloning only the necessary files to your local machine.

$git clone https://github.com/akshaynstack/epiclips.git
$cd epiclips

02.Configure Environment

Copy the example environment file and update it with your API keys.

$cp .env.example .env

03.Run with Docker Compose

Start the entire stack (backend + frontend) with a single command.

$docker-compose up -d

The API will be available at http://localhost:8000 and the app at http://localhost:3000

Option 2: Manual Setup

Backend Setup

1. Initialize and install dependencies using uv:

$uv sync --python 3.11

2. Run the development server:

$uv run uvicorn app.main:app --reload --host 0.0.0.0 --port 8000
Frontend Setup

1. Navigate to frontend directory and install dependencies:

$cd frontend && npm install

2. Start Next.js development server:

$npm run dev

Environment Variables

Create a .env file in the root directory:

# AI Services
OPENROUTER_API_KEY=your_key
OPENROUTER_MODEL=google/gemini-flash-1.5-8b
GROQ_API_KEY=your_key

# Optional
AWS_ACCESS_KEY_ID=...
AWS_SECRET_ACCESS_KEY=...
WEBHOOK_URL=...