Skip to content

EARTHTOEDWARD/research-paper-summarizer

Repository files navigation

Research Paper Summarizer

An AI-powered tool that watches a folder for research papers (PDF/TXT) and automatically generates summaries with key insights.

Features

  • 📁 Auto-watch: Drop papers into the papers/ folder
  • 🤖 AI Analysis: Uses OpenAI to extract key insights
  • 🌐 Web Interface: View summaries at http://localhost:3000
  • 🔄 Live Updates: Auto-refreshes every 30 seconds

Prerequisites

Quick Start

  1. Clone and install:

    git clone https://github.com/EARTHTOEDWARD/research-paper-summarizer.git
    cd research-paper-summarizer
    npm install
  2. Set your OpenAI API key:

    export OPENAI_API_KEY="your-api-key-here"
  3. Start the backend (watches for papers):

    cd backend
    npm install
    npm run dev
  4. Start the frontend (in a new terminal):

    cd frontend
    npm install
    npm run dev
  5. Add papers:

How It Works

  1. Backend watches the papers/ folder for new PDF/TXT files
  2. Extracts text and metadata (title, authors)
  3. Sends to OpenAI for insight generation
  4. Saves summaries to docs/research-insights.md
  5. Frontend displays the summaries with auto-refresh

Configuration

  • Watch folder: papers/ (configurable in backend)
  • Output file: docs/research-insights.md
  • Token limit: 200,000 per day (configurable via DAILY_TOKEN_BUDGET)
  • Refresh rate: 30 seconds (frontend)

Docker Option

If you prefer Docker:

docker-compose up

This starts both backend and frontend in containers.

Example Output

When you add a paper, you'll see something like:

## Understanding Complex Systems
- **Authors:** Jane Smith, John Doe
- **Source:** complexity-theory.pdf
- **Key insights:**
  - Complex systems exhibit emergent behavior
  - Feedback loops are crucial in system dynamics
  - Non-linear interactions lead to unpredictability

Troubleshooting

"OPENAI_API_KEY not set"

  • Make sure to export your API key before starting

"Port 3000 already in use"

  • The frontend will suggest an alternative port

Papers not being processed

  • Check the backend terminal for errors
  • Ensure files are PDF or TXT format
  • Check your OpenAI API key is valid

Privacy Note

  • All processing happens locally on your machine
  • Only the text is sent to OpenAI for summarization
  • No data is stored externally

License

MIT

About

AI-powered tool to summarize research papers

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published