Skip to main content

Prerequisites

  • Node.js 22+
  • pnpm 9+
  • PostgreSQL database (local for dev, or a Neon project)
  • OpenAI API key
  • Slack workspace (for bot features)

1. Clone and Install

2. Configure Environment

Copy the example env file and fill in your values:
The minimum required variables:
Use 127.0.0.1 instead of localhost in redirect URIs. WorkOS requires this for local development.

3. Set Up Database

4. Build and Run

The app is now running at http://127.0.0.1:3000.

5. Test the Setup

1

Visit the signup page

Go to http://127.0.0.1:3000/auth/signup and create a workspace.
2

Complete WorkOS verification

Follow the email verification flow through WorkOS.
3

Explore the dashboard

After verification, you’ll land on the workspace dashboard where you can create and manage documents.

Common Issues

Go to WorkOS Dashboard → Applications → Your App → Redirect URIs and add http://127.0.0.1:3000/api/auth/workos/callback. Make sure to use 127.0.0.1, not localhost.
Verify PostgreSQL is running with pg_isready, then test the connection:
In the WorkOS Dashboard, go to Organizations and enable “Allow organization creation via API”.

Next Steps

CLI

Manage documents and folders from your terminal.

Slack Setup

Connect Whilst to your Slack workspace.

Architecture

Understand the system design.