Quick Start

Get UniSync running locally in 5 minutes.

Prerequisites

• Python 3.11+ installed
• Node.js 18+ installed
• PostgreSQL 15+ running on localhost:5432
• API key for at least one AI provider (OpenAI, Google Gemini, or Anthropic)

Step 1: Database Setup

Create the PostgreSQL database:

CREATE DATABASE ai_content;

UniSync automatically creates all tables on first startup.

Step 2: Backend Setup

cd backend
pip install -r requirements.txt

Create a .env file in the backend/ directory:

DB_HOST=localhost
DB_PORT=5432
DB_NAME=ai_content
DB_USER=postgres
DB_PASSWORD=your_password
JWT_SECRET=your_jwt_secret_key

Start the backend:

uvicorn api_server.main:app --reload --port 8000

The API is now running at http://localhost:8000. You can access:

• Swagger UI: http://localhost:8000/docs
• ReDoc: http://localhost:8000/redoc

Step 3: Frontend Setup

cd frontend
npm install
npm run dev

The frontend is now running at http://localhost:5173.

Step 4: First-Time Configuration

1. Register — Create your account at http://localhost:5173/register
2. Wizard Setup — The onboarding wizard guides you through:
   • Adding API credentials (OpenAI, Gemini, etc.)
   • Creating your first environment (WordPress or Astro site)
   • Creating your first AI agent
   • Assigning an automation or campaign planner

See Wizard Setup for a detailed walkthrough.

Step 5: Generate Your First Content

Quick Publisher (fastest)

1. Go to Manage Agents and create an agent
2. Assign a Search Phrase automation (e.g., "how to build a deck")
3. Go to Run Agents and click Run
4. Content is generated and published to your environment

Production Agent (SEO-optimized)

1. Go to SEO Intelligence and create a keyword plan
2. Create a campaign planner and assign the keyword plan
3. Generate and approve content strategies
4. Assign the planner to an agent
5. Run the agent — the 9-phase pipeline handles the rest

What's Next?

• Architecture — Understand the system design
• Agents — Deep dive into agent configuration
• SEO Intelligence — Keyword research and campaigns
• Configuration — Environment and API setup