Docs
Quickstart

Quickstart

Get GudDesk up and running with our hosted cloud or a local development setup.

This guide gets you from zero to a working GudDesk instance.

Option A: Hosted Cloud (Fastest)

  1. Create an account at guddesk.com/register
  2. Create a workspace and configure your workspace name
  3. Install the chat widget on your site (see Widget Installation)
  4. Start chatting: open your site and send a test message

That's it. Your shared inbox and knowledge base are ready to go.

Option B: Local Development

Prerequisites

  • Node.js 20.19 or later
  • pnpm
  • PostgreSQL (local or hosted, for example Neon)

Steps

# 1. Clone the repository
git clone https://github.com/gudlab/guddesk-core.git
cd guddesk-core
 
# 2. Install dependencies
pnpm install
 
# 3. Set up environment variables
cp .env.example .env

Edit .env with your configuration:

DATABASE_URL="postgresql://user:password@localhost:5432/guddesk"
AUTH_SECRET="your-random-secret-here"
NEXT_PUBLIC_APP_URL="http://localhost:3000"
GOOGLE_CLIENT_ID="your-google-client-id"
GOOGLE_CLIENT_SECRET="your-google-client-secret"
RESEND_API_KEY="your-resend-api-key"
# 4. Push the database schema
pnpm prisma db push
 
# 5. Build the chat widget
pnpm run build:widget
 
# 6. Start the development server
pnpm dev

Open http://localhost:3000. You should see the GudDesk dashboard.

Next Steps