​
Quickstart Guide

This guide will help you get ChatterMate up and running quickly.

​
Installation

​
Backend Setup

# Clone the repository
git clone https://github.com/chattermate/chattermate
cd chattermate/backend

# Create and activate virtual environment
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

​
Frontend Setup

# Navigate to frontend directory
cd frontend

# Install dependencies
npm install

# Configure environment
cp .env.example .env.local

​
Database Setup

1

Create Database

Create a PostgreSQL database and enable the vector extension:

CREATE DATABASE chattermate;
\c chattermate
CREATE EXTENSION vector;
2

Run Migrations

Apply the database migrations:

alembic upgrade head

​
Running the Application

​
Development Mode

# Start the backend server
uvicorn app.main:app --reload --port 8000

​
Production Mode

# Start the production server
gunicorn -k uvicorn.workers.UvicornWorker -w 4 main:app

​
Verify Installation

  1. Open your browser and navigate to http://localhost:8000/docs to view the API documentation
  2. Visit http://localhost:3000 to access the web interface
  3. Try sending a test message in the chat widget

​
Next Steps

Setup Organization

Setup new organization

Configure AI

Configure AI provider

Customize AI Agent

Customizing AI agent

Knowledge Base

Adding knowledge to AI agent

Testing

Testing AI agent

Widget Integration

Adding chat widget to the website

Human Agents

Adding Human Agent

Roles & Permissions

Managing Roles and Permission

Chat Management

Managing Customer chat and Taking over chat

Availability

Going offline

IntroductionSetup Organization