jono/deep-research-web-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: update README

Browse Source
This commit is contained in:
AnotiaWang
2025-02-13 16:04:24 +08:00
parent 7aaa7ab527
commit 2ecd1e2213
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -4,12 +4,14 @@ This is a web UI for https://github.com/dzhng/deep-research.
Features: Features:
- Stream AI responses for realtime feedback - **Realtime feedback**: Stream AI responses and reflect on the UI in real-time
- Viasualization of the research process using a tree structure - **Search visualization**: Shows the research process using a tree structure
- Export research report as PDF - **Export as PDF**: Export the final research report as a PDF
- Bring Your Own API Key: Everything (config, API requests, ...) happens in your browser - **Bring Your Own API Key**: Everything (config, API requests, ...) happens in your browser
- **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.
Currently available providers: Currently available providers:
- AI: OpenAI compatible - AI: OpenAI compatible
- Web Search: Tavily (similar to Firecrawl, but with more free quota (1000 credits / month)) - Web Search: Tavily (similar to Firecrawl, but with more free quota (1000 credits / month))
@ -24,11 +26,13 @@ Live demo: <a href="https://deep-research.ataw.top" target="_blank">https://deep
### Self hosted ### Self hosted
Use pre-built Docker image: Use pre-built Docker image:
```bash ```bash
docker run -p 3000:3000 --name deep-research-web -d anotia/deep-research-web:latest docker run -p 3000:3000 --name deep-research-web -d anotia/deep-research-web:latest
``` ```
Use self-built Docker image: Use self-built Docker image:
``` ```
git clone https://github.com/AnotiaWang/deep-research-web-ui git clone https://github.com/AnotiaWang/deep-research-web-ui
cd deep-research-web-ui cd deep-research-web-ui
@ -62,11 +66,13 @@ pnpm dev
Build the application for production: Build the application for production:
If you want to deploy a SSR application: If you want to deploy a SSR application:
```bash ```bash
pnpm build pnpm build
``` ```
If you want to deploy a static, SSG application: If you want to deploy a static, SSG application:
```bash ```bash
pnpm generate pnpm generate
``` ```