Documentation Index
Fetch the complete documentation index at: https://docs.folksbase.joselito.dev/llms.txt
Use this file to discover all available pages before exploring further.
folksbase uses GitHub Actions for continuous integration and selective deployment. Workflows live in .github/workflows/.
CI Pipeline (ci.yml)
Runs on every pull request targeting main. All jobs must pass before merging.
Jobs
| Job | Command | What It Checks |
|---|
| Lint | pnpm lint | Biome formatting and lint rules |
| Typecheck | pnpm typecheck | TypeScript strict mode across all packages |
| Test | pnpm test | Vitest unit tests across all packages |
| Build | pnpm build | Full production build (runs after lint, typecheck, and test pass) |
| Claude Code Review | — | AI-powered review against AGENTS.md rules |
Claude Code Review
An AI reviewer checks every PR against the project rules in AGENTS.md. It looks for:
- TypeScript violations (
any, non-null assertions, missing types)
- Backend layer violations (routes importing from
@folksbase/db)
console.log usage (should use the structured logger)process.env usage (should use the typed env module)- OFFSET-based pagination (should use cursor-based)
- Redis calls without TTL
- Inngest jobs without
step.run() wrappers
This runs as a separate job and posts inline comments on the PR.
Concurrency
concurrency:
group: ci-${{ github.ref }}
cancel-in-progress: true
Storybook Deployment (deploy-storybook.yml)
Deploys the Storybook component documentation to Netlify. Only triggers when relevant files change.
Trigger Paths
paths:
- "apps/web/src/components/**"
- "apps/web/.storybook/**"
- "packages/types/**"
Process
- Installs dependencies with
pnpm install
- Builds Storybook with
pnpm --filter @folksbase/web build-storybook
- Deploys the static output to Netlify
Requires NETLIFY_AUTH_TOKEN and NETLIFY_SITE_ID secrets in the repository settings.
These aren’t GitHub Actions — they’re platform-native deploy hooks:
| Platform | Trigger | What Deploys |
|---|
| Vercel | Push to main | Web app (apps/web) |
| Render | Push to main | API (apps/api) |
| Mintlify | Push to main | Docs (apps/docs) — auto-syncs with GitHub |
Local Equivalents
The CI pipeline mirrors the local git hooks:
| CI Job | Local Hook | Command |
|---|
| Lint | pre-commit | pnpm lint |
| Typecheck | pre-push | pnpm typecheck |
| Test | pre-push | pnpm test |
| Build | pre-push | pnpm build |
.githooks/ and activated automatically by pnpm install.
Required Secrets
| Secret | Used By |
|---|
ANTHROPIC_API_KEY | Claude code review workflow |
NETLIFY_AUTH_TOKEN | Storybook deployment |
NETLIFY_SITE_ID | Storybook deployment |
