-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
47 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 [email protected]: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` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,13 @@ | ||
| <!doctype html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8" /> | ||
| <link rel="icon" type="image/svg+xml" href="/vite.svg" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
| <title>Vite + React</title> | ||
| </head> | ||
| <body> | ||
| <div id="root"></div> | ||
| <script type="module" src="/src/main.jsx"></script> | ||
| </body> | ||
| <head> | ||
| <meta charset="UTF-8"/> | ||
| <!-- <link rel="icon" type="image/svg+xml" href="/vite.svg"/>--> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"/> | ||
| <title>clippit</title> | ||
| </head> | ||
| <body> | ||
| <div id="root"></div> | ||
| <script type="module" src="/src/main.jsx"></script> | ||
| </body> | ||
| </html> |