mirror of https://github.com/wu736139669/hapi.git synced 2026-08-05 06:24:37 +00:00

Files

T

weishu 4f03f29ac3 docs: rebrand Happy to HAPI and add component documentation

This commit rebrands the project from "Happy" to "HAPI" throughout the codebase, including documentation, comments, logs, and tool references. It also adds comprehensive README files for the server and web components, clarifies the monorepo structure in AGENTS.md and root README.md, and removes the outdated roadmap.md file.

Changes include:
- Rebrand references from Happy to HAPI in CLI, server, and web components
- MCP tool names updated from mcp__happy__ to mcp__hapi__
- Process/service names updated consistently
- New server/README.md with deployment and configuration guide
- New web/README.md with stack and development instructions
- Updated root README.md with quickstart guide
- Updated AGENTS.md with cleaner structure documentation
- Removed cli/roadmap.md (now superseded by documentation)

2025-12-21 18:49:04 +08:00

scripts

feat(cli): add single executable with embedded web assets support

2025-12-21 08:42:00 +08:00

src

docs: rebrand Happy to HAPI and add component documentation

2025-12-21 18:49:04 +08:00

package.json

docs: rebrand Happy to HAPI and add component documentation

2025-12-21 18:49:04 +08:00

README.md

docs: rebrand Happy to HAPI and add component documentation

2025-12-21 18:49:04 +08:00

tsconfig.json

feat(cli): add single executable with embedded web assets support

2025-12-21 08:42:00 +08:00

README.md

hapi-server

Telegram bot + HTTP API + realtime updates for hapi.

What it does

Telegram bot for notifications and the Mini App entrypoint.
HTTP API for sessions, messages, permissions, machines, and files.
Server-Sent Events stream for live updates in the web app.
Socket.IO channel for CLI connections.
Serves the web app from web/dist or embedded assets in the single binary.
Persists state in SQLite.

Typical deployment flow

Configure env vars.
Expose the server to the internet (HTTPS) if you need Telegram Mini App access.
Run the server.
Point the CLI to the server and open the web app.

Configuration

Required:

TELEGRAM_BOT_TOKEN - token from @BotFather.
ALLOWED_CHAT_IDS - comma-separated chat IDs allowed to use the bot.
CLI_API_TOKEN - shared secret used by CLI and web login.

Optional:

WEBAPP_PORT - HTTP port (default: 3006).
WEBAPP_URL - public URL for Telegram Mini App button.
CORS_ORIGINS - comma-separated origins, or *.
HAPI_BOT_DATA_DIR - data directory (default: ~/.hapi-server).
DB_PATH - SQLite database path.

Running

Binary (single executable):

export TELEGRAM_BOT_TOKEN="..."
export ALLOWED_CHAT_IDS="12345678"
export CLI_API_TOKEN="shared-secret"
export WEBAPP_URL="https://your-domain.example"

hapi server

From source:

bun install
bun run dev:server

Or inside server/:

bun run start

Build for deployment

From the repo root:

bun run build:server
bun run build:web

The server build output is server/dist/index.js, and the web assets are in web/dist.

Networking notes

Telegram Mini Apps require HTTPS and a public URL. If the server has no public IP, use Cloudflare Tunnel or Tailscale and set WEBAPP_URL to the HTTPS endpoint.
If the web app is hosted on a different origin, set CORS_ORIGINS accordingly.

Architecture overview

The server is the hub for direct-connect mode. It accepts CLI connections over Socket.IO, exposes HTTP endpoints for the web UI, and publishes live updates over SSE. A Telegram bot provides notifications and a Mini App entrypoint. Session and machine state are stored in a local SQLite database.

Security model

Access is controlled by:

Telegram chat ID allowlist.
CLI_API_TOKEN shared secret for CLI and browser access.

Transport security depends on HTTPS in front of the server.