Data Whisperer ๐๏ธ is a chatbot that allows you to analyze your local files using Large Language Models (LLMs). You can upload PDFs, Markdown, Text, and Document files to the chatbot and ask questions related to the content of those files.
To run this project in your environment, follow these steps:
-
Clone the Repository:
git clone https://github.com/manthan89-py/DataWhisperer.git
-
Create a Virtual Environment: Create a virtual environment using Python or Conda and activate it.
-
Install Backend Dependencies: Navigate to the
backend
folder and install the dependencies using:pip install -r requirements.txt
-
Add your OPENAPI_KEY: Add your OPENAPI_KEY to the
.env
file in thebackend
folder. -
Start the Backend: Start the backend app using Uvicorn:
uvicorn main:app --reload
-
Install Node.js and npm: Ensure you have Node.js and npm installed. For example, Node.js version 20.11.1 and npm version 10.2.4 or higher.
-
Install Frontend Dependencies: Navigate to the
frontend
folder and install the dependencies using:npm install
-
Start the Frontend: Start the frontend app using:
npm start
- File Types Supported: PDF, Markdown, Text, and Document files.
- Backend Framework: FastAPI for creating RESTful APIs.
- Frontend Framework: React for the user interface.
- Dependencies: See
requirements.txt
for backend dependencies andpackage.json
for frontend dependencies.