# YSK Kit

- Canonical: https://ysk.hk/products/ysk-kit
- This page: https://ysk.hk/en/products/ysk-kit
- Markdown: https://ysk.hk/en/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

Contract-first full-stack platform for new products: shared contracts, hexagonal API, and optional web, admin, mobile, and desktop clients. CLI `ysk-kit` (alias `yskk`). Requires Node 24 and pnpm 12. Default ports API 3001, web 5173, admin 5174.

## Install

1. Scaffold (thin · MySQL · saas): `pnpm create @ysk-kit/app my-product --preset thin --db mysql --flavor saas`
2. Install · env · database: `pnpm install` · `cp .env.example .env` · `docker compose up -d mysql`
3. Generate / migrate / seed: `pnpm db:generate && pnpm db:migrate && pnpm db:seed`
4. Add a module → 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 strips llm, billing, organizations (team), and push. Restore with `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

Overlays apply onto a new product directory; they are not mounted in this kit. Product domains stay in the product repository.

## Limits

Not a YSK-hosted multi-tenant SaaS. The product still runs on a host you own or the contract names. `ysk-kit upgrade` refreshes guardrails; it is not the daily path of installing `@ysk-kit/*` from the registry.

## FAQ

Q: Is YSK Kit free and open source?
A: Yes. MIT licensed for you to install. Scaffold or custom work: see Business. No prices on this page.

Q: How is it different from YSK Omni and YSK Server?
A: Omni is a local-model gateway. Server is a single-host Linux control plane. Kit is the contract-first platform you scaffold a new product from.

Q: Which Node version is required?
A: Node.js 24 and pnpm 12. Default ports: API 3001, web 5173, admin 5174.

Q: What is the difference between thin and full?
A: Thin (default) strips llm, billing, organizations, and push. Full keeps the living demonstration. Restore with pnpm ysk-kit add.

Q: Do industry domains belong in the kit?
A: No. Product domains stay in the product repository. The ten examples are overlays applied onto a new directory.

Q: Does custom work become YSK-hosted SaaS?
A: No. The product still runs on a host you own or the contract names. YSK does not operate a multi-tenant cloud edition of YSK Kit.

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