DeerFlow is a community-driven AI automation framework that builds upon the incredible work of the open source community. Our goal is to combine language models with specialized tools for tasks like web search, crawling, and Python code execution, while giving back to the community that made this possible.

How to Install

DeerFlow Web UI uses pnpm as package manager.

cd web
pnpm install

How to Run in Development Mode

Note: You need to start the Python API service before running the web UI.

Start the web UI development server:

cd web
pnpm dev

By default, the web UI will be available at http://localhost:3000.

This project uses a inverted proxy to access the API service. By default, the post request to http://localhost:3000/api/chat/stream will be proxied to http://localhost:8000/api/chat/stream.

You can set the NEXT_PUBLIC_API_URL environment variable to change the default API service URL.

# .env
NEXT_PUBLIC_API_URL=http://localhost:8000/api

License

This project is open source and available under the MIT License.

Acknowledgments

Special thanks to all the open source projects and contributors that make DeerFlow possible. We stand on the shoulders of giants.

In particular, we want to express our deep appreciation for:

Next.js for their exceptional framework
Shadcn for their minimalistic components that powers our UI
Zustand for their stunning state management
Framer Motion for their amazing animation library
React Markdown for their exceptional markdown rendering and customizability
Last but not least, special thanks to SToneX for his great contribution for token-by-token visual effect

These amazing projects form the foundation of DeerFlow and demonstrate the power of open source collaboration.