Skip to content

README.md

Latest commit

 

History

History
62 lines (49 loc) · 1.3 KB

README.md

File metadata and controls

62 lines (49 loc) · 1.3 KB

LLM RealityCheck

A Chrome Extension + FastAPI backend for identifying and labeling AI-generated hallucinations in LLM responses.

🛠️ Step-by-Step Installation Guide (Developer Setup)

You can follow these instructions to get the backend up and running locally.

Prerequisites

Make sure you have the following installed:

  • Python 3.10+
  • Git
  • Visual Studio Code (or your preferred IDE)
  • Uvicorn (automatically installed via requirements)

Installation Steps

1. Create a Python Virtual Environment

python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate

2. Clone the Repository

git clone https://github.com/Emdya/LLM-Reality-Check.git

3. Navigate to the Project Directory

cd LLM-Reality Check

4. Open the Project in VS Code

code .

5. Install Backend Requirements

pip install -r backend/requirements.txt

6. Launch the FastAPI Server

uvicorn main:app --reload

7. Access the API Docs

Once the server is running, you'll see a message like:

INFO:     Uvicorn running on http://127.0.0.1:8000

Open your browser and visit:

http://127.0.0.1:8000/docs

to interact with the API via the Swagger UI