Helper

In-app customer support center + live chat powered by API.

Quick Start

Install dependencies

You'll need:

• Docker
• Node.js (see .node-version)

Install local Certificate Authority

# Install mkcert on macOS
brew install mkcert
brew install nss

# Install mkcert on Windows
# First ensure you have Chocolately installed (https://chocolatey.org/install), then:
choco install mkcert

For other operating systems, see the mkcert installation guide.

Set up environment variables

Tip

If you already have a Vercel project with development environment variables set up, you can skip this step. When you run pnpm dev you will be prompted to pull the environment variables from Vercel.

Copy .env.local.sample to .env.local, then fill in values for:

OpenAI

1. Create an account at openai.com.
2. Create a new API key at platform.openai.com/api-keys.
3. Add the API key to your .env.local file as OPENAI_API_KEY.

The app will start with placeholder values for other services - you can follow the instructions in the development guide to enable them later.

Install dependencies

pnpm install

Seed the database with sample data

pnpm db:reset

Start the application

pnpm dev

Access the application at helperai.dev 🚀

Docs

• Project structure
• Local development
• Deployment

License

Helper is licensed under the MIT License.