An AI-powered search engine with a generative UI
TypeScript generative-aigenerative-uinextjsollamareactsearxngshadcn-uitailwindcsstavilytypescriptupstashvercel-ai-sdk
docs: Add CLAUDE.md for Claude Code guidance
Yoshiki Miura0f30edcfa41d
diff --git a/CLAUDE.md b/CLAUDE.mdnew file mode 100644index 00000000..26faee84--- /dev/null+++ b/CLAUDE.md@@ -0,0 +1,102 @@+# CLAUDE.md++This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.++## Key Commands++### Development+- `bun dev` - Start development server with Next.js Turbo mode (http://localhost:3000)+- `bun build` - Create production build+- `bun start` - Start production server+- `bun lint` - Run ESLint for code quality checks++### Docker+- `docker compose up -d` - Run the application with Docker+- `docker pull ghcr.io/miurla/morphic:latest` - Pull prebuilt Docker image++## Architecture Overview++### Tech Stack+- **Next.js 15.2.3** with App Router and React Server Components+- **React 19.0.0** with TypeScript for type safety+- **Vercel AI SDK 4.3.6** for AI streaming and GenerativeUI+- **Supabase** for authentication and backend services+- **Redis** (Upstash or local) for chat history storage+- **Tailwind CSS** with shadcn/ui components++### Core Architecture++1. **App Router Structure** (`/app`)+ - `/api/` - Backend API routes for chat, search, and auth endpoints+ - `/auth/` - Authentication pages (login, signup, password reset)+ - `/search/` - Search functionality and results display+ - `/share/` - Sharing functionality for search results++2. **AI Integration** (`/lib`)+ - `/lib/agents/` - AI agents for research and question generation+ - `/lib/config/` - Model configuration management+ - `/lib/streaming/` - Stream handling for AI responses+ - `/lib/tools/` - Search and retrieval tool implementations+ - Models configured in `public/config/models.json`++3. **Search System**+ - Multiple providers: Tavily (default), SearXNG (self-hosted), Exa (neural)+ - Video search support via Serper API+ - URL-specific search capabilities+ - Configurable search depth and result limits++4. **Component Organization** (`/components`)+ - `/artifact/` - Search result and AI response display components+ - `/sidebar/` - Chat history and navigation+ - `/ui/` - Reusable UI components from shadcn/ui+ - Feature-specific components (auth forms, chat interfaces)++5. **State Management**+ - Server-side state via React Server Components+ - Client-side hooks in `/hooks/`+ - Redis for persistent chat history+ - Supabase for user data++## Environment Configuration++### Required Variables+```bash+OPENAI_API_KEY= # Default AI provider+TAVILY_API_KEY= # Default search provider+```++### Optional Features+- Chat history: Set `NEXT_PUBLIC_ENABLE_SAVE_CHAT_HISTORY=true` and configure Redis+- Alternative AI providers: Add corresponding API keys (ANTHROPIC_API_KEY, GOOGLE_GENERATIVE_AI_API_KEY, etc.)+- Alternative search: Configure SEARCH_API and provider-specific settings+- Sharing: Set `NEXT_PUBLIC_ENABLE_SHARE=true`++## Key Development Patterns++1. **AI Streaming**: Uses Vercel AI SDK's streaming capabilities for real-time responses+2. **GenerativeUI**: Dynamic UI components generated based on AI responses+3. **Type Safety**: Strict TypeScript configuration with comprehensive type definitions in `/lib/types/`+4. **Schema Validation**: Zod schemas in `/lib/schema/` for data validation+5. **Error Handling**: Comprehensive error boundaries and fallback UI components++## Testing Approach+Currently no dedicated test framework. Verify changes by:+1. Running `bun lint` to check code quality+2. Building with `bun build` to catch TypeScript errors+3. Manual testing in development mode++## Model Configuration+Models are defined in `public/config/models.json` with:+- `id`: Model identifier+- `provider`: Display name+- `providerId`: Provider key for API routing+- `enabled`: Toggle availability+- `toolCallType`: "native" or "manual" for function calling+- `toolCallModel`: Optional override for tool calls++## Database Policies+When working with Supabase, follow the cursor rules in `.cursor/rules/` for:+- Creating migrations+- Setting up RLS policies+- Writing edge functions+- SQL style guide\ No newline at end of file