Thanks to visit codestin.com
Credit goes to Github.com

Skip to content

FrontDeskHQ/front-desk

Repository files navigation

FrontDesk

License: AGPL PRs Welcome

The all-in-one customer support platform. Making good customer support extremely easy.

Website   •   Discord Community   •   Documentation

Follow @frontdeskhq

FrontDesk is an open-source customer support platform designed to help you assist your customers wherever they are. Built with design as a first-class citizen, it provides a seamless and lightning-fast experience for both support teams and customers.

Features

  • Beautiful, Modern UI - Thoughtfully designed interface built with TailwindCSS and shadcn/ui
  • Lightning Fast - Built on TanStack Start for optimal performance
  • Real-time Updates - Live state synchronization for instant updates
  • Multi-channel Support - Connect with customers via Discord and more
  • Multi-tenant - Support multiple organizations with subdomain routing
  • Secure Authentication - Built-in auth with Better Auth
  • Responsive Design - Works seamlessly across all devices
  • Developer Friendly - TypeScript, modern tooling, and excellent DX

Getting Started

Prerequisites

  • Node.js 18 or higher
  • pnpm (package manager)
  • Docker (for local development with database)

Installation

  1. Clone the repository:

    git clone https://github.com/frontdeskhq/front-desk.git
    cd front-desk
  2. Install dependencies:

    pnpm install
  3. Set up environment variables:

    cp apps/api/.env.local.example apps/api/.env.local

    Update the environment variables in apps/api/.env.local with your configuration.

  4. Start the development servers:

    pnpm dev

    This will start:

    • Frontend web app (typically on http://localhost:3000)
    • Backend API server (typically on http://localhost:3333)
    • Discord bot (if configured)

Project Structure

This project uses a monorepo structure powered by Turborepo and pnpm workspaces.

front-desk/
├── apps/
│   ├── api/              # Backend API (Express + live-state)
│   ├── discord/          # Discord bot integration
│   ├── waitlist/         # Waitlist landing page
│   └── web/              # Frontend application (TanStack Start)
├── packages/
│   ├── emails/           # Email templates
│   ├── schemas/          # Shared Zod schemas
│   └── ui/               # Shared UI components (shadcn/ui)
└── docker-compose.yaml   # Local development setup

Key Technologies

  • Frontend: TanStack Start, React, TypeScript, TailwindCSS
  • Backend: Express, live-state, Better Auth
  • Database: PostgreSQL
  • Styling: TailwindCSS, shadcn/ui
  • Build Tool: Vite, Turborepo
  • Package Manager: pnpm

Contributing

We welcome contributions! Whether you're fixing bugs, adding features, or improving documentation, your help makes FrontDesk better for everyone.

Alt

How to Contribute

  1. Fork the repository
  2. Create a feature branch (git checkout -b feat/amazing-feature)
  3. Make your changes and ensure code follows project standards
  4. Commit your changes (git commit -m 'feat: Add amazing feature')
  5. Push to your branch (git push origin feat/amazing-feature)
  6. Open a Pull Request

Development Guidelines

  • Follow the existing code style and conventions
  • Write clear commit messages following Conventional Commits
  • Add tests for new features when applicable
  • Update documentation as needed

Note: We're working on a comprehensive contributing guide. In the meantime, feel free to open an issue or reach out on Discord if you have questions!

License

This project is licensed under the AGPL License - see the LICENSE file for details.


Made with love by the FrontDesk team

WebsiteDiscordGitHub

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •