helpthread
GitHubGet started

Docs

Get started

Helpthread deploys into a Vercel project and a Supabase project that you own. This guide takes you from a clone to a working operator inbox.

Developer preview. Helpthread runs Resonant IQ's own support operation in production, and you can deploy it today. APIs and interfaces may change before 1.0, and there is no upgrade-compatibility promise until then.

Prerequisites

Node 20 or laternode --version
A Vercel account, Pro or aboveApplication runtime and cron
A Supabase accountPostgres and Storage
A mailbox Helpthread can readGmail, or any IMAP mailbox

Deploy

1

Clone and install

Fork or clone the repository, then install dependencies.

$ git clone https://github.com/Helpthread/helpthread.git
$ cd helpthread && npm install
2

Create your Supabase project

Create a project in your own Supabase organisation and apply the database migrations.

$ DATABASE_URL='postgres://…' npm run migrate
3

Link your Vercel project

Create one Vercel project from your fork with Root Directory web, then add the environment variables the deployment spec lists — specs/deploy/single-project.md in the repository.

$ vercel link
$ vercel env add [VARIABLE]
4

Deploy

Deploy to production. Your operator inbox is served from your own domain.

$ vercel deploy --prod
5

Connect inbound mail

Connect a mailbox from the running app: Gmail through Google consent, or any IMAP mailbox with its host and credentials. Gmail is pushed to your deployment, IMAP is fetched on a schedule. Replies thread by signed tokens carried in every outbound message.

Next

Architecture →How conversations, threading, queues and storage fit together.Public roadmap →What is being built next, in the open.Founding Charter →The principles the project is governed by.