Code Monkey home page Code Monkey logo

chatpdf's Introduction

ChatPDF

ChatPDF is a web app that can understand and answer questions about an uploaded PDF document. It serves as an assistant to help researchers, students, or professionals quickly find precise information from PDFs.

1

Installation

This is a Next.js project bootstrapped with create-next-app.

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

Key Features

  • Upload a PDF and ask questions about its content
  • Powered by AI to read and understand PDF documents
  • Provides accurate answers to questions in plain language
  • Built using Next.js, React, TypeScript, and other modern technologies
  • Hosted on Vercel for fast, global access with minimal latency
  • Leverages AWS S3, LangChain, Pinecone, and ChatGPT to understand documents and generate answers
  • Improved UI/UX and logic flow to prevent Open Error on temp folder compared to original, plus user account management by adding ‘users’ table and making chat link ‘/chat/{userID}/{chatID}’ (instead of ‘/chat/{chatID}’)

Demo

A live demo is available here:

https://chatpdf-andrew.vercel.app/

Try it out by uploading a PDF or using one of the samples!

Hosting

ChatPDF is currently hosted on Vercel and leverages its serverless platform for scale, speed, and ease of use. The front-end application is hosted on Vercel Edge locations around the world to minimize latency. PDF documents are stored in AWS S3 buckets in relevant regions.

The UI is a progressive web app that caches content like App Shell architecture. Pages render extremely quickly even for complex pages due to granular caching and static optimization.

Table of Contents

Usage

Uploading PDFs:

Click the upload button and select a PDF file from your computer. Wait for it to process (depending on size this takes 5-15 seconds).

Asking Questions:

Type questions related to the content of the PDF in plain English into the text prompt area - e.g. "What is the main topic of this research paper?". The AI will scan the uploaded document and attempt to return an accurate answer by analyzing the content.

Managing Conversations:

Logged in users can access a personalized dashboard to manage conversations, PDFs uploaded, and questions asked. Share the dashboard link to keep discussions ongoing.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Credits

ChatPDF was inspired by Elliott Chong's YouTube Tutorial. It builds on his open-sourced project with UI and architectural improvements.

Huge thanks to:

Tri Thien Nguyen

chatpdf's People

Contributors

andrewthien avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.