Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fdarkaou/open-deep-research

Last synced: 10 days ago
JSON representation

Host: GitHub
URL: https://github.com/fdarkaou/open-deep-research
Owner: fdarkaou
License: mit
Created: 2025-02-07T16:45:18.000Z (14 days ago)
Default Branch: main
Last Pushed: 2025-02-07T16:50:01.000Z (14 days ago)
Last Synced: 2025-02-07T17:31:14.799Z (14 days ago)
Language: TypeScript
Size: 0 Bytes
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Open Deep Research Web UI

A modern, interactive web interface built on top of the original [Deep Research CLI](https://github.com/dzhng/deep-research) project. This web app transforms the command-line research assistant into an intuitive, visually appealing experience using Next.js and shadcn/ui.

## Overview

Open Deep Research Web UI is an AI-powered research assistant that transforms the original CLI tool into a modern web interface using Next.js and shadcn/ui. Try it out at [anotherwrapper.com/open-deep-research](https://anotherwrapper.com/open-deep-research) with your own API keys, or host it yourself.

The system combines search engines (via FireCrawl), web scraping, and language models (via OpenAI) to perform deep research on any topic. Key features include:

- **Intelligent Research Process:**

- Performs iterative research by recursively exploring topics in depth
- Uses LLMs to generate targeted search queries based on research goals
- Creates follow-up questions to better understand research needs
- Processes multiple searches and results in parallel for efficiency
- Configurable depth and breadth parameters to control research scope

- **Research Output:**

- Produces detailed markdown reports with findings and sources
- Real-time progress tracking of research steps
- Built-in markdown viewer for reviewing results
- Downloadable research reports

- **Modern Interface:**
- Interactive controls for adjusting research parameters
- Visual feedback for ongoing research progress
- HTTP-only cookie storage for API keys

The system maintains the core research capabilities of the original CLI while providing an intuitive visual interface for controlling and monitoring the research process.

## Sponsors

This project is proudly sponsored by [Anotherwrapper](https://anotherwrapper.com).

[![Sponsored by Anotherwrapper](https://anotherwrapper.com/og.png)](https://anotherwrapper.com)

## Getting Started

### Prerequisites

- Node.js v14 or later
- API keys for OpenAI and FireCrawl

### Installation

1. **Clone and Install**

```bash
git clone https://github.com/fdarkaou/open-deep-research.git
cd open-deep-research
npm install
```

2. **Configure Environment**

Create `.env.local` and add:

```bash
OPENAI_API_KEY=your-openai-api-key
FIRECRAWL_KEY=your-firecrawl-api-key
NEXT_PUBLIC_ENABLE_API_KEYS=false # Set to false to disable API key dialog
```

3. **Run the App**
```bash
npm run dev
```
Visit [http://localhost:3000](http://localhost:3000)

## API Key Management

By default (`NEXT_PUBLIC_ENABLE_API_KEYS=true`), the app includes an API key input dialog that allows users to try out the research assistant directly in their browser using their own API keys. Keys are stored securely in HTTP-only cookies and are never exposed to client-side JavaScript.

For your own deployment, you can disable this dialog by setting `NEXT_PUBLIC_ENABLE_API_KEYS=false` and configure the API keys directly in your `.env.local` file instead.

## License

MIT License. Feel free to use and modify the code for your own projects as you wish.

## Acknowledgements

- **Original CLI:** [dzhng/deep-research](https://github.com/dzhng/deep-research)
- **Sponsor:** [Anotherwrapper](https://anotherwrapper.com)
- **Tools:** Next.js, shadcn/ui, anotherwrapper, Vercel AI SDK

Happy researching!