# Happ Developer Documentation

Internal developer documentation for the Happ Platform platform

> Full REST + WebSocket API reference: https://api.happ.tools/reference

## Welcome [#welcome]

This is the internal developer documentation for the **Happ Platform platform** — a multi-channel AI assistant system for businesses. It covers architecture, project structure, development workflows, and operational guides for the engineering team.

## Platform Overview [#platform-overview]

Happ enables businesses to deploy AI-powered assistants across messaging channels (Telegram, Instagram, WhatsApp, Facebook Messenger, Viber) and voice calls, managed from a single dashboard.

### Access [#access]

All internal services and documentation are protected by **Cloudflare Zero Trust**. To access any `*.happ.tools` service (dashboards, APIs, docs), you must authenticate through the Cloudflare Access portal. Access policies are managed in the [Cloudflare Zero Trust dashboard](https://one.dash.cloudflare.com).

### System Components [#system-components]

| Project                                                             | Role             | Tech Stack                          | Docs                                                             |
| ------------------------------------------------------------------- | ---------------- | ----------------------------------- | ---------------------------------------------------------------- |
| [platform-api](./projects/platform-api.mdx)                         | Backend API      | NestJS 11 + TypeORM + PostgreSQL 16 | [api.docs.happ.tools](https://api.docs.happ.tools)               |
| [platform-admin](./projects/platform-admin.mdx)                     | Admin dashboard  | Angular 21 + Material M3 + SSR      | [admin.docs.happ.tools](https://admin.docs.happ.tools)           |
| [platform-client](./projects/platform-client.mdx)                   | Customer web app | Angular 21 + SSR                    | [client.docs.happ.tools](https://client.docs.happ.tools)         |
| [platform-mobile](./projects/platform-mobile.mdx)                   | Mobile app       | Expo SDK 54 + React Native 0.81     | [mobile.docs.happ.tools](https://mobile.docs.happ.tools)         |
| [platform-telegram-client](./projects/platform-telegram-client.mdx) | Telegram bot     | NestJS 11 + Telegraf                | [telegram.docs.happ.tools](https://telegram.docs.happ.tools)     |
| [platform-deploy](./projects/platform-deploy.mdx)                   | Infrastructure   | Docker Compose + Traefik            | [deploy.docs.happ.tools](https://deploy.docs.happ.tools)         |
| [platform-monitoring](./projects/platform-monitoring.mdx)           | Observability    | Prometheus + Grafana + Loki + Tempo | [monitoring.docs.happ.tools](https://monitoring.docs.happ.tools) |
| [platform-e2e](./projects/platform-e2e.mdx)                         | E2E tests        | Playwright                          | [e2e.docs.happ.tools](https://e2e.docs.happ.tools)               |
| [platform-docs](./projects/platform-docs.mdx)                       | Documentation    | Next.js 15 + Fumadocs               | —                                                                |

Each project is a **separate Git repository** under the [Happ-AI](https://github.com/Happ-AI) GitHub organization.

## Quick Navigation [#quick-navigation]

<Cards>
  <Card title="Onboarding Checklist" href="/dev/development/onboarding" />

  <Card title="Architecture Overview" href="/dev/architecture/overview" />

  <Card title="Getting Started" href="/dev/development/getting-started" />

  <Card title="Troubleshooting" href="/dev/development/troubleshooting" />

  <Card title="Coding Conventions" href="/dev/development/conventions" />

  <Card title="All Links & Dashboards" href="/dev/resources/links" />
</Cards>