Quick Start

This guide will get OpenSNS running on your local machine in under 5 minutes.

Prerequisites

• Python 3.11+
• Node.js 18+ or Bun
• Git

Installation

Docker (Recommended)

The fastest way to get started:

# Clone the repository
git clone https://github.com/opensns-dev/opensns.git
cd opensns

# Copy environment files
cp backend/.env.example backend/.env

# Start all services
docker-compose up -d

Access the app:

• Frontend: http://localhost:3000
• API Docs: http://localhost:8000/docs

Manual Setup

1. Clone and setup backend

   git clone https://github.com/opensns-dev/opensns.git
   cd opensns/backend
   
   # Create virtual environment
   python -m venv venv
   source venv/bin/activate  # Windows: venv\Scripts\activate
   
   # Install dependencies
   pip install -r requirements.txt
   
   # Install Playwright browser
   playwright install chromium
   
   # Configure environment
   cp .env.example .env
   # Edit .env with your settings

2. Start the backend

   uvicorn app.main:app --reload

3. Setup frontend (new terminal)

   cd opensns/frontend
   bun install
   bun dev

4. Open the app

   Navigate to http://localhost:3000

First Steps

1. Register an account

   Go to http://localhost:3000/register and create your account.

2. Configure API keys (optional)

   Navigate to Settings and add your API keys:

   • OpenAI API Key - For AI text generation
   • Fal.ai API Key - For image/video generation

   Tip

   OpenSNS works without API keys in “fallback mode” - it will use placeholder content for testing.

3. Create your first campaign

   Go to Campaigns → Create Campaign, enter a product URL, and watch the AI generate your assets!

What’s Next?

• Configuration Guide - Customize your setup
• API Keys Setup - Configure AI providers
• Creating Campaigns - Learn the campaign workflow