Installation¶

System requirements¶

Method 1: Local development¶

Install Node.js dependencies¶

git clone https://github.com/InstinctBits/convergioai.git
cd convergioai
npm install

Set up PostgreSQL¶

Create the database:

createdb convergioai

Initialize all schemas:

node run-schema.js

This executes six schema files:

1. schema.sql — Core tables (emails, tasks, auto-replies, app settings)
2. schema-better-auth.sql — Better Auth tables (users, sessions, accounts, organizations)
3. schema-settings.sql — User settings, API keys, email signatures
4. schema-calendar.sql — Calendar events
5. schema-streamboost.sql — Stream state, announcements, platform credentials, milestones
6. schema-threading.sql — Email threading (Message-ID, In-Reply-To, References)

Start the servers¶

# Start both frontend and backend concurrently
npm run dev:all

# Or start them separately
npm run dev      # Frontend (Vite) — port 5173
npm run server   # Backend (Express) — port 3001

Method 2: Docker¶

# Build and start all services
docker-compose up -d

# Access the application
# Frontend: http://localhost:5173
# Backend:  http://localhost:3001

Method 3: Production with PM2¶

# Install PM2 globally
npm install -g pm2

# Build the frontend
npm run build

# Start with PM2
pm2 start pm2.ecosystem.config.cjs

n8n workflow setup (optional)¶

To set up n8n:

1. Install n8n (self-hosted or cloud)
2. Import workflow files from n8n-workflows/
3. Configure credentials in n8n
4. Activate the workflows

Verify installation¶

# Check the API health
curl http://localhost:3001/

Next steps¶

• Quickstart — Get running in 10 minutes
• Configuration — Environment variables and API keys
• Architecture — Understand the system design