155 lines
4.1 KiB
Markdown
155 lines
4.1 KiB
Markdown
# Deep Research Web UI
|
|
|
|
[English | [中文](README_zh.md)]
|
|
|
|
This is a web UI for https://github.com/dzhng/deep-research, with several improvements and fixes.
|
|
|
|
Features:
|
|
|
|
- 🚀 **Safe & Secure**: Everything (config, API requests, ...) stays in your browser locally
|
|
- 🕙 **Realtime feedback**: Stream AI responses and reflect on the UI in real-time
|
|
- 🌳 **Search visualization**: Shows the research process using a tree structure. Supports searching in different languages
|
|
- 📄 **Export as PDF**: Export the final research report as Markdown / PDF
|
|
- 🤖 **Supports more models**: Uses plain prompts instead of newer, less widely supported features like Structured Outputs. This ensures to work with more providers that haven't caught up with the latest OpenAI capabilities.
|
|
- 🐳 **Docker support**: Deploy in your environment in one-line command
|
|
|
|
Currently available providers:
|
|
|
|
- AI: OpenAI compatible, SiliconFlow, DeepSeek, OpenRouter, Ollama and more
|
|
- Web Search: Tavily (1000 free credits / month), Firecrawl (cloud / self-hosted)
|
|
|
|
Please give a 🌟 Star if you like this project!
|
|
|
|
<video width="500" src="https://github.com/user-attachments/assets/8f9baa43-a74e-4613-aebb-1bcc29a686f0" controls></video>
|
|
|
|
## Recent updates
|
|
|
|
25/02/24
|
|
|
|
- Added: Fullscreen mode for the search flow. This helps you to focus on the search process better.
|
|
- Changed: "Export PDF" now uses the browser's native print ability. This fixes layout issues and emilinates font problems.
|
|
- Fixed: "Context Size" setting are not correctly applied
|
|
|
|
25/02/22
|
|
|
|
- Added: NL/Dutch translation
|
|
- Added: Retry failed nodes in web search
|
|
- Fixed: Web search node sometimes shows empty label and duplicated learnings
|
|
- Fixed: Firecrawl now limits scrape content format to `Markdown`
|
|
|
|
25/02/18 - 25/02/20
|
|
|
|
- Added: "advanced search" and "search topic" support for Tavily
|
|
- Added: custom endpoint support for Firecrawl
|
|
- Fixed: overall bug fixes, less "invalid JSON structure" errors
|
|
|
|
25/02/17
|
|
|
|
- Added: set rate limits for web search
|
|
- Added: set context length for AI model
|
|
|
|
25/02/16
|
|
|
|
- Refactored the search visualization using VueFlow
|
|
- Style & bug fixes
|
|
|
|
25/02/15
|
|
|
|
- Added AI providers DeepSeek, OpenRouter and Ollama; Added web search provider Firecrawl
|
|
- Supported checking project updates
|
|
- Supported regenerating reports
|
|
- General fixes
|
|
|
|
<details>
|
|
<summary>Older updates</summary>
|
|
|
|
25/02/14
|
|
|
|
- Supported reasoning models like DeepSeek R1
|
|
- Improved compatibility with more models & error handling
|
|
|
|
25/02/13
|
|
|
|
- Significantly reduced bundle size
|
|
- Supported searching in different languages
|
|
- Added Docker support
|
|
- Fixed "export as PDF" issues
|
|
</details>
|
|
|
|
## How to use
|
|
|
|
Live demo: <a href="https://deep-research.ataw.top" target="_blank">https://deep-research.ataw.top</a>
|
|
|
|
### Self hosted
|
|
|
|
One-click deploy with [EdgeOne Pages](https://edgeone.ai/products/pages):
|
|
|
|
[](https://edgeone.ai/pages/new?from=github&template=https://github.com/AnotiaWang/deep-research-web-ui&from=github)
|
|
|
|
Use pre-built Docker image:
|
|
|
|
```bash
|
|
docker run -p 3000:3000 --name deep-research-web -d anotia/deep-research-web:latest
|
|
```
|
|
|
|
Use self-built Docker image:
|
|
|
|
```
|
|
git clone https://github.com/AnotiaWang/deep-research-web-ui
|
|
cd deep-research-web-ui
|
|
docker build -t deep-research-web .
|
|
docker run -p 3000:3000 --name deep-research-web -d deep-research-web
|
|
```
|
|
|
|
---
|
|
|
|
## Developing
|
|
|
|
### Setup
|
|
|
|
Make sure to install dependencies:
|
|
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
## Development Server
|
|
|
|
Start the development server on `http://localhost:3000`:
|
|
|
|
```bash
|
|
pnpm dev
|
|
```
|
|
|
|
## Production
|
|
|
|
Build the application for production:
|
|
|
|
If you want to deploy a SSR application:
|
|
|
|
```bash
|
|
pnpm build
|
|
```
|
|
|
|
If you want to deploy a static, SSG application:
|
|
|
|
```bash
|
|
pnpm generate
|
|
```
|
|
|
|
Locally preview production build:
|
|
|
|
```bash
|
|
pnpm preview
|
|
```
|
|
|
|
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
|
|
|
|
## License
|
|
|
|
MIT
|
|
|
|
## Star History
|
|
|
|
[](https://star-history.com/#AnotiaWang/deep-research-web-ui&Date)
|