# YSK Kit

- Canonical: https://ysk.hk/products/ysk-kit
- English: https://ysk.hk/en/products/ysk-kit
- Markdown: https://ysk.hk/products/ysk-kit.md
- Source: https://github.com/yanshekki/ysk-kit
- npm: @ysk-kit/create-app
- License: MIT
- Version: 1.0.1
- Publisher: YSK Limited

合約先行全端平台：共用合約、hexagonal API，以及可選的 Web、Admin、流動應用與桌面客戶端。CLI `ysk-kit`（alias `yskk`）。需要 Node 24 與 pnpm 12。預設埠 API 3001、Web 5173、Admin 5174。

## Install

1. 產生產品（thin · MySQL · saas）：`pnpm create @ysk-kit/app my-product --preset thin --db mysql --flavor saas`
2. 安裝 · 環境 · 資料庫：`pnpm install` · `cp .env.example .env` · `docker compose up -d mysql`
3. 產生／遷移／種子：`pnpm db:generate && pnpm db:migrate && pnpm db:seed`
4. 加模組 → pnpm dev：`pnpm ysk-kit add module appointment --prisma --web` then `pnpm gen:openapi` then `pnpm dev` — http://127.0.0.1:3001 / :5173 / :5174

## Flavors

saas, desktop, gateway, php-bridge, trading, static-web3

## Capabilities

auth, rbac, audit-log, storage, i18n, jobs, mail, notifications, llm, websocket, push, mobile, team, apikey, crypto, billing

Thin 剝走 llm、billing、organizations（team）與 push。還原：`pnpm ysk-kit add llm|team|billing|push`。

## Examples

clinic-booking, crm-contacts, inventory-stock, helpdesk-tickets, membership-club, course-enrollment, invoice-quotes, event-rsvp, job-board, field-work-orders

Overlay 套到新產品目錄，不掛進 kit 倉。產品業務 domain 留在產品倉。

## Limits

不是 YSK 代管的多租戶雲端 SaaS。產品仍裝在您擁有或合約指定的主機。`ysk-kit upgrade` 只更新 guardrails，不是每日從 registry 安裝 `@ysk-kit/*`。

## FAQ

Q: YSK Kit 是否免費開源？
A: 是。MIT 開源，可自行安裝使用。代為 scaffold 或訂造見商務合作，此頁不標價。

Q: 與 YSK Omni、YSK Server 有何分別？
A: Omni 是本機模型閘道。Server 是單機 Linux 控制平面。Kit 是開新產品用的合約先行全端平台。

Q: 需要哪個 Node 版本？
A: Node.js 24 與 pnpm 12。預設 API 埠 3001、Web 5173、Admin 5174。

Q: thin 與 full 有何分別？
A: 預設 thin 剝走 llm、billing、organizations 與 push。full 保留完整示範。還原用 pnpm ysk-kit add。

Q: 產品業務要寫在 kit 裏嗎？
A: 不要。行業 domain 留在產品倉。十個範例是 overlay，套用到新目錄。

Q: 訂造後會否變成 YSK 代管的雲端 SaaS？
A: 不會。產品仍裝在您擁有或合約指定的主機。YSK 不做多租戶雲端版 YSK Kit。

Contact: WhatsApp +852 6160 4242 / email@ysk.hk