mirror of https://github.com/RSSNext/Folo.git synced 2026-10-19 06:22:12 +08:00

Files

T

Innei ba7e6ce8ce chore: create AGENTS.md for comprehensive project guidance

- Introduced AGENTS.md to provide detailed, agent-focused guidance for working within the monorepo.
- Consolidated existing CLAUDE.md content and added new sections on project overview, setup commands, quality gates, code style, architecture, UI design tokens, and testing strategies.
- Established clear guidelines for component placement, reusable UI components, and agent workflows to enhance development consistency across applications.

This addition aims to streamline onboarding and improve collaboration among team members by providing a centralized resource for best practices and project structure.

Signed-off-by: Innei <tukon479@gmail.com>

2025-09-22 23:33:37 +08:00

1.4 KiB

Raw Permalink Blame History

AGENTS.md

This file provides specific guidance for developing shared packages used across all platforms.

Overview

The packages/internal/ directory contains core shared packages that provide common functionality across desktop, mobile, and SSR applications.

Package Structure

atoms/ - Jotai atomic state definitions
components/ - Shared UI components
constants/ - Application constants
database/ - Drizzle ORM database layer
hooks/ - Shared React hooks
models/ - Data models and schemas
shared/ - Cross-platform shared utilities
store/ - Zustand stores
types/ - TypeScript type definitions
utils/ - Utility functions and helpers
tracker/ - Analytics and tracking
logger/ - Logging utilities
legal/ - Legal and compliance utilities

State Management

Jotai for atomic state management across all platforms
Zustand for complex state stores (in packages/internal/store/)
React Query for server state management

Database

Drizzle ORM with SQLite for local data storage
Platform-specific database implementations in packages/internal/database/
Migration system with versioned SQL files

Component Development Guidelines

Shared UI components in packages/internal/components/
Platform-specific components in respective app directories
Use TypeScript interfaces for component props
Follow cross-platform compatibility patterns

1.4 KiB Raw Permalink Blame History