This file provides guidance for AI coding assistants working with this codebase.
Freundebuch - A self-hostable web application for relationship management (a digital friendship book for adults). See docs/architecture.md for full details and docs/brand.md for brand guidelines.
| Document | Purpose |
|---|---|
| docs/architecture.md | Tech stack, monorepo structure, feature roadmap |
| docs/development.md | Workflow, commands, git conventions, testing |
| docs/principles.md | Core principles and design constraints |
| docs/tone.md | Writing style guidelines |
| docs/design-language.md | Visual design system |
| docs/database-conventions.md | Database design patterns |
| docs/git-workflow.md | Branching model, commit conventions, git hooks |
Each workspace has its own AGENTS.md with specific guidance:
- apps/frontend/AGENTS.md - SvelteKit, components, stores
- apps/backend/AGENTS.md - Hono, routes, database, auth
- packages/shared/AGENTS.md - Types, schemas, utilities
Use the gh CLI to interact with issues and PRs:
gh issue list # List open issues
gh issue view <number> # View issue details
gh pr list # List open PRs
gh pr view <number> # View PR detailsSee docs/development.md for full list.
# Database (run from root)
pnpm migrate:create <name> # Create new migration
pnpm migrate # Run pending migrations
pnpm pgtyped # Generate types from SQL
# Development
pnpm dev # Run all dev servers
pnpm check # Lint + format
pnpm test # Run all tests
# Docker
pnpm docker:up # Start database
pnpm docker:down # Stop database- TypeScript strict mode everywhere
- No
anytypes - useunknownand narrow - ArkType for runtime validation at API boundaries
- PgTyped for type-safe SQL queries
- Biome for linting and formatting
- Test coverage target: >80%
- All tests must pass before merging
Detailed implementation plans are in project-management/epics/.