From b3a4ae9a8e6cecf25e1bbec67588f984e811daea Mon Sep 17 00:00:00 2001 From: Ashley Huo Date: Sat, 20 Apr 2024 19:43:13 -0400 Subject: [PATCH] update readme and page title --- README.md | 42 +++++++++++++++++++++++++++++++++++++----- index.html | 20 ++++++++++---------- 2 files changed, 47 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index f768e33..c56c79a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,40 @@ -# React + Vite +# Clippit - An LLM-powered Chat Application for PDFs -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. +This is a LLM-powered chat application in React, similar to ChatPDF +and ChatGPT. The application should allow users to ask questions related to a PDF +document uploaded by them, with the LLM providing accurate answers by leveraging RAG +techniques. -Currently, two official plugins are available: +User will need to provide their own OpenAI API key to use this application. -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh +## Features + +- PDF text extraction +- Chat interface for asking questions +- Integration with OpenAI's GPT-3 for answering questions +- Ability to upload PDFs + +## Development + +This project can be run locally by following these steps: + +Clone the repository and install the dependencies: + +```bash +git clone git@github.com:Ashleyhx/clippit.git +cd clippit +npm install +``` + +Run the development server: + +```bash +npm run dev +``` + +## Technologies + +- **Frontend**: React, Mantine UI +- **Build Tool**: Vite +- **PDF Processing**: `react-pdftotext` library +- **API Integration**: `gpt-3.5-turbo` diff --git a/index.html b/index.html index 0c589ec..bf45d66 100644 --- a/index.html +++ b/index.html @@ -1,13 +1,13 @@ - - - - - Vite + React - - -
- - + + + + + clippit + + +
+ +