Skip to content
Pocat Documentation

Installation

Installation

Section titled “Installation”

Learn how to install and setup Pocat for development or production use.

Using the Live API

Section titled “Using the Live API”

The easiest way to get started is using our live API endpoint:

Base URL: https://nonimitating-corie-extemporary.ngrok-free.dev

No installation required - just start making requests!

Self-Hosted Installation

Section titled “Self-Hosted Installation”

Prerequisites

Section titled “Prerequisites”
  • Node.js 18+
  • pnpm
  • Python 3.8+ (for yt-dlp)
  • FFmpeg

Clone Repository

Section titled “Clone Repository”
Terminal window
git clone https://github.com/konxc/pocat-api.git
cd pocat-api

Install Dependencies

Section titled “Install Dependencies”
Terminal window
pnpm install

Environment Setup

Section titled “Environment Setup”
Terminal window
cp .env.example .env
# Edit .env with your configuration

Run Development Server

Section titled “Run Development Server”
Terminal window
pnpm run dev

Your API will be available at http://localhost:3333

Docker Installation

Section titled “Docker Installation”
Terminal window
docker pull pocat/api:latest
docker run -p 3333:3333 pocat/api:latest

Next Steps

Section titled “Next Steps”