wanwu/deer-flow
1
0
Fork 0
mirror of https://gitee.com/wanwujie/deer-flow synced 2026-04-21 05:14:45 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: add docker support (#104)

Browse Source 
* init docker support

* chore: update Dockerfile and .dockerignore for improved build context and dependency management

* feat: add Docker support with Dockerfile, docker-compose, and .dockerignore for web application

* feat: update environment configuration and docker-compose for improved API integration

* docs: update Japanese and Chinese README files for consistency and clarity
This commit is contained in:
Leo Hui
2025-05-13 19:53:28 +08:00
committed by GitHub
parent 71808802de
commit 9c3021a568
12 changed files with 663 additions and 245 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
web/README.md
View File

@@ -6,6 +6,26 @@
This is the web UI for [`DeerFlow`](https://github.com/bytedance/deer-flow).
## Quick Start
### Prerequisites
- [`DeerFlow`](https://github.com/bytedance/deer-flow)
- Node.js (v22.14.0+)
- pnpm (v10.6.2+) as package manager
### Configuration
Create a `.env` file in the project root and configure the following environment variables:
- `NEXT_PUBLIC_API_URL`: The URL of the deer-flow API.
It's always a good idea to start with the given example file, and edit the `.env` file with your own values:
```bash
cp .env.example .env
```
## How to Install
DeerFlow Web UI uses `pnpm` as its package manager.
@@ -37,6 +57,39 @@ You can set the `NEXT_PUBLIC_API_URL` environment variable if you're using a dif
NEXT_PUBLIC_API_URL=http://localhost:8000/api
```
## Docker
You can also run this project with Docker.
First, you need read the [configuration](#configuration) below. Make sure `.env` file is ready.
Second, to build a Docker image of your own web server:
```bash
docker build --build-arg NEXT_PUBLIC_API_URL=YOUR_DEER-FLOW_API -t deer-flow-web .
```
Final, start up a docker container running the web server:
```bash
# Replace deer-flow-web-app with your preferred container name
docker run -d -t -p 3000:3000 --env-file .env --name deer-flow-web-app deer-flow-web
# stop the server
docker stop deer-flow-web-app
```
### Docker Compose
You can also setup this project with the docker compose:
```bash
# building docker image
docker compose build
# start the server
docker compose up
```
## License
@@ -48,11 +101,12 @@ We extend our heartfelt gratitude to the open source community for their invalua
DeerFlow is built upon the foundation of these outstanding projects:
In particular, we want to express our deep appreciation for:
* [Next.js](https://nextjs.org/) for their exceptional framework
* [Shadcn](https://ui.shadcn.com/) for their minimalistic components that powers our UI
* [Zustand](https://zustand.docs.pmnd.rs/) for their stunning state management
* [Framer Motion](https://www.framer.com/motion/) for their amazing animation library
* [React Markdown](https://www.npmjs.com/package/react-markdown) for their exceptional markdown rendering and customizability
* Last but not least, special thanks to [SToneX](https://github.com/stonexer) for his great contribution for [token-by-token visual effect](./src/core/rehype/rehype-split-words-into-spans.ts)
- [Next.js](https://nextjs.org/) for their exceptional framework
- [Shadcn](https://ui.shadcn.com/) for their minimalistic components that powers our UI
- [Zustand](https://zustand.docs.pmnd.rs/) for their stunning state management
- [Framer Motion](https://www.framer.com/motion/) for their amazing animation library
- [React Markdown](https://www.npmjs.com/package/react-markdown) for their exceptional markdown rendering and customizability
- Last but not least, special thanks to [SToneX](https://github.com/stonexer) for his great contribution for [token-by-token visual effect](./src/core/rehype/rehype-split-words-into-spans.ts)
These outstanding projects form the backbone of DeerFlow and exemplify the transformative power of open source collaboration.