Skip to content

frontend

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

frontend

README.md

DeerFlow Frontend

Like the original DeerFlow 1.0, we would love to give the community a minimalistic and easy-to-use web interface with a more modern and flexible architecture.

Tech Stack

Quick Start

Prerequisites

  • Node.js 22+
  • pnpm 10.26.2+

Installation

# Install dependencies pnpm install # Copy environment variables cp .env.example .env # Edit .env with your configuration

Development

# Start development server pnpm dev # The app will be available at http://localhost:3000

Build

# Type check pnpm typecheck # Lint pnpm lint # Build for production pnpm build # Start production server pnpm start

Site Map

├── / # Landing page ├── /chats # Chat list ├── /chats/new # New chat page └── /chats/[thread_id] # A specific chat page

Configuration

Environment Variables

Key environment variables (see .env.example for full list):

# Backend API URLs (optional, uses nginx proxy by default) NEXT_PUBLIC_BACKEND_BASE_URL="http://localhost:8001" # LangGraph API URLs (optional, uses nginx proxy by default) NEXT_PUBLIC_LANGGRAPH_BASE_URL="http://localhost:2024"

Project Structure

src/ ├── app/ # Next.js App Router pages │ ├── api/ # API routes │ ├── workspace/ # Main workspace pages │ └── mock/ # Mock/demo pages ├── components/ # React components │ ├── ui/ # Reusable UI components │ ├── workspace/ # Workspace-specific components │ ├── landing/ # Landing page components │ └── ai-elements/ # AI-related UI elements ├── core/ # Core business logic │ ├── api/ # API client & data fetching │ ├── artifacts/ # Artifact management │ ├── config/ # App configuration │ ├── i18n/ # Internationalization │ ├── mcp/ # MCP integration │ ├── messages/ # Message handling │ ├── models/ # Data models & types │ ├── settings/ # User settings │ ├── skills/ # Skills system │ ├── threads/ # Thread management │ ├── todos/ # Todo system │ └── utils/ # Utility functions ├── hooks/ # Custom React hooks ├── lib/ # Shared libraries & utilities ├── server/ # Server-side code (Not available yet) │ └── better-auth/ # Authentication setup (Not available yet) └── styles/ # Global styles

Scripts

Command Description
pnpm dev Start development server with Turbopack
pnpm build Build for production
pnpm start Start production server
pnpm lint Run ESLint
pnpm lint:fix Fix ESLint issues
pnpm typecheck Run TypeScript type checking
pnpm check Run both lint and typecheck

Development Notes

  • Uses pnpm workspaces (see packageManager in package.json)
  • Turbopack enabled by default in development for faster builds
  • Environment validation can be skipped with SKIP_ENV_VALIDATION=1 (useful for Docker)
  • Backend API URLs are optional; nginx proxy is used by default in development

License

MIT License. See LICENSE for details.