Quickstart Guide

This guide will help you get ChatterMate up and running quickly using our CLI tool. The fastest way to get ChatterMate running is with our CLI tool:
1

Install CLI

Install the ChatterMate CLI globally:
npm install -g chattermate-cli
2

Create Project

Initialize a new ChatterMate project:
chattermate init my-chattermate-project
cd my-chattermate-project
3

Start Services

Start all services with Docker:
chattermate start
4

Access Dashboard

Open your browser and visit:
  • Frontend Dashboard: http://localhost/
  • Backend API: http://localhost:8000
  • API Documentation: http://localhost:8000/docs

CLI Commands

chattermate init <project-name>    # Initialize a new project
chattermate reset                  # Reset and cleanup project

Manual Installation

If you prefer to set up ChatterMate manually or need custom configuration:

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

# Copy and configure environment variables
cp .env.example .env
# Edit .env file with your configurations

Frontend Setup

# Navigate to frontend directory
cd frontend

# Install dependencies
npm install

# Copy and configure environment variables
cp .env.example .env
# Edit .env file with your configurations

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

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

Verify Installation

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

Next Steps