DOCUMENT_ANALYZER

Backend Setup Guide

This guide will help you set up and run the backend for the Document Analyzer project using FastAPI and Gemini AI.

---

Prerequisites

Make sure you have the following installed:

• Python 3.9 or later
• pip (Python package manager)
• virtualenv (optional but recommended)

---

Step 1: Create and Activate a Virtual Environment

Run the following commands to create and activate a virtual environment:

# Create a virtual environment
python -m venv venv

# Activate the virtual environment
# On Windows
venv\Scripts\activate

# On macOS/Linux
source venv/bin/activate

---

Step 2: Install Dependencies

Run the following command to install the required packages:

pip install -r requirements.txt

If requirements.txt is not available, install the dependencies manually:

pip install fastapi uvicorn pdfplumber python-docx python-dotenv google-generativeai

---

Step 3: Set Up Environment Variables

Create a .env file in the root directory and add your Gemini AI API key:

GENAI_API_KEY=your_api_key_here

Replace your_api_key_here with your actual API key.

---

Step 4: Run the FastAPI Server

Use the following command to start the server:

uvicorn main:app --reload

By default, the server will run on http://127.0.0.1:8000.

---

Step 5: API Endpoints

Upload a Document

• Endpoint: POST /upload
• Description: Uploads a .pdf or .docx file, extracts text, and processes it using Gemini AI.
• Response:

  {
      "message": "File uploaded successfully",
      "filename": "document.pdf",
      "extracted_text": "...",
      "key_points": "<h2>Extracted Key Points</h2>..."
  }

---

Step 6: Deactivating the Virtual Environment

After you're done, deactivate the virtual environment:

deactivate

---

Frontend Setup Guide

This guide will help you set up and run the frontend for the Document Analyzer project using React and Vite.

---

Prerequisites

Make sure you have the following installed:

• Node.js (Latest LTS recommended)
• npm (Comes with Node.js) or yarn (optional)

---

Step 1: Navigate to the Frontend Directory

If you haven't already, navigate to the frontend directory:

cd frontend

---

Step 2: Install Dependencies

Run the following command to install the required packages:

npm install

---

Step 3: Start the Development Server

Run the following command to start the frontend:

npm run dev

By default, the frontend will be available at http://localhost:5173.