diff --git a/.agents/skills/workflow/onboard-new-developer/SKILL.md b/.agents/skills/workflow/onboard-new-developer/SKILL.md index 89846e2c..7531ccd8 100644 --- a/.agents/skills/workflow/onboard-new-developer/SKILL.md +++ b/.agents/skills/workflow/onboard-new-developer/SKILL.md @@ -4,13 +4,15 @@ description: Comprehensive onboarding process to get new developer up and runnin disable-model-invocation: true --- -Comprehensive onboarding process to get new developer up and running quickly. +Comprehensive onboarding process to get a new developer up and running quickly. Product Ready is this fork-and-run path, not CI green. Canonical checklist: `apps/docu/content/docs/testing/product-ready.mdx`. -1. **Environment setup**: Install required tools, set up development environment, configure IDE/extensions, set up git/SSH keys -2. **Clone and setup**: Run `pnpm setup` at repo root +1. **Environment setup**: Install required tools, set up development environment, configure IDE/extensions, set up git/SSH keys (Node 24, pnpm from `packageManager`) +2. **Clone and setup**: Run `pnpm setup` at repo root (install, hooks, env templates, Docker/Supabase CLI, Playwright) 3. **Decide context**: Local only, or remote VPC? (Remote VPC = dev machine in cloud; trade-offs: networking, access, cost, latency. See `apps/docu/content/docs/development/dev-environments.mdx`.) -4. **Run web/API**: `pnpm dev` (API + Next.js) -5. **Run mobile (optional)**: `pnpm --filter @repo/mobile start` (or `start:localhost` / `start:tunnel` for remote). See `apps/docu/content/docs/development/dev-environments.mdx` -6. **Verify**: Simulator/device can load the app and reach the API -7. **Project familiarization**: Review project structure, understand architecture, read key documentation, set up local database, verify all tests passing, submit first PR - +4. **Start local Postgres**: `pnpm --filter @repo/api db:start` (`setup` does not start Supabase) +5. **Reset and seed**: `pnpm reset` from repo root (Supabase reset + Drizzle migrate + seed). See `apps/api/README.md` and ADR 008 +6. **Run web/API**: `pnpm dev` (API + Next.js) +7. **First login**: Magic link, or `ALLOW_TEST=true` + `test@test.ai`. Signed-in home is `/` +8. **Run mobile (optional)**: `pnpm --filter @repo/mobile start` (or `start:localhost` / `start:tunnel` for remote). See `apps/docu/content/docs/development/dev-environments.mdx` +9. **Verify**: Web loads, API `GET /health` succeeds, simulator/device can reach the API if running mobile +10. **Project familiarization**: Review `_first/`, Product docs, architecture MDX; run tests when changing code; submit first PR diff --git a/README.md b/README.md index 1c59fe4d..561cca04 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # Basilic: API-First TypeScript FullStack Starter -Build production-ready APIs and apps with typed SDKs, out-of-the-box authentication, a portable architecture, AI tooling, and crypto integrations. -Fastify • OpenAPI • Next.js • Expo — one stack, multiple platforms. +Fork-and-run developer starter: typed SDKs, self-hosted auth, a portable architecture, Cursor-first workflow, and a thin web demo. Fastify • OpenAPI • Next.js • Expo scaffold — one stack, multiple clients. > 🚧 **Active development** — Explore, fork, and contribute. 🏗️ @@ -10,21 +9,21 @@ Fastify • OpenAPI • Next.js • Expo — one stack, multiple platforms. - 🤖 **AI-first dev workflow** — Agent rules, skills, MCP integrations, and automated CodeRabbit reviews - 🔌 **REST API & JWT** — OpenAPI spec, Swagger UI, JWT and API key auth for all clients - 📦 **SDK generation** — Type-safe clients from OpenAPI via HeyAPI -- 🧩 **Web3 & AI starters** — Ready-to-use templates for Next.js, React, Expo, and Fastify +- 🧩 **Web + API starters** — Next.js demo, React hooks, Expo UI scaffold, Fastify API (not a wallet or OpenAI template) - 🔓 **Zero vendor lock-in** — Run on VPS, AWS, Vercel, or local - 🎨 **Turbo monorepo + design system** — ShadcnUI components with shared utilities - ⚙️ **Preconfigured dev tools** — Biome, Git workflows, hooks, and security checks - 🛡️ **Security & quality** — Automated checks in CI (Gitleaks, OSV, DeepSec) -- ⛓️ **Multichain** — EVM, Solana; shared validation and chain-specific tooling +- ⛓️ **Multichain (API)** — EVM and Solana SIWE/SIWS on Fastify; shared `@repo/utils/web3` helpers — not a web wallet demo - 📐 **Conventions** — Cursor rules per domain, @repo/error, Pino logging, shared TS and style - 🧑‍💻 **TypeScript-first** — End-to-end types from database to frontend ## Technology stack -- **AI:** AI SDK, OpenAI, Claude, Grok +- **AI (in-app):** AI SDK — Anthropic, OpenRouter, Ollama (no first-class OpenAI SDK) - **Frontend:** Next.js 16, React 19, Tailwind, ShadcnUI - **Backend:** Fastify, PostgreSQL, Supabase -- **Web3:** Viem, Wagmi, Solana wallet tooling in shared packages +- **Web3:** Fastify SIWE/SIWS + `@repo/utils/web3` helpers. **No Wagmi and no wallet UI in `apps/web`** - **DevOps:** Node.js 24.x (LTS Krypton), pnpm, TurboRepo, TypeScript, Biome, ESLint ## Apps @@ -32,7 +31,7 @@ Fastify • OpenAPI • Next.js • Expo — one stack, multiple platforms. - **[API](apps/api/README.md)** — Type-safe REST API built with Fastify & OpenAPI - **[Web App](apps/web/README.md)** — Next.js app with monorepo integration - **[Mobile App](apps/mobile/README.md)** — Expo UI scaffold (shared `@repo/ui`; not an API client yet) -- **[Documentation](apps/docu/README.md)** — Fumadocs-based docs site for architecture, ADRs, and development workflows +- **[Documentation](apps/docu/README.md)** — Fumadocs site ([Product](https://basilic-docs.vercel.app/docs/product), architecture, ADRs, development) ## Packages @@ -96,5 +95,9 @@ Run with `pnpm