trippleCheck - AI Agent (FastAPI & SvelteKit Edition)

A web application featuring a FastAPI backend and a SvelteKit frontend. It utilizes an AI pipeline (analysis, perspective generation, verification, synthesis) to answer user queries, with the option to add text or image files as context.

Features

• Processes natural language queries.
• Supports uploading multiple file formats:
  • Documents: .txt, .pdf, .md, .doc, .docx, .odt, .rtf
  • Spreadsheets: .xlsx, .xls, .ods, .csv
  • Presentations: .pptx, .ppt, .odp
  • Images: .jpg, .jpeg, .png, .gif, .bmp, .tiff (with OCR)
  • Archives: .zip, .rar
  • Markup: .xml, .html
  • E-books: .epub
• Utilizes AI models from OpenRouter.
• Features a 3-step AI processing pipeline:
  1. Analysis: Understands the query and context.
  2. Perspective Generation: Creates three distinct perspectives (Informative, Contrarian, Complementary) in parallel.
  3. Verification & Synthesis: Evaluates the perspectives using Google Search, compares them, and synthesizes a final, verified answer.
• Pixel art styled user interface built with SvelteKit.

System Requirements

• Python 3.8 or higher
• Node.js 16 or higher
• Tesseract OCR 5.0 or higher (for image processing)
• At least 4GB RAM
• 500MB free disk space

Local Setup

1. Clone the repository:

   git clone https://github.com/makaronz/trippleCheck.git
   cd trippleCheck

2. Create and activate a virtual environment (recommended):

   # Create environment for backend
   python -m venv venv
   # Windows
   .\venv\Scripts\activate
   # macOS/Linux
   source venv/bin/activate

3. Install backend dependencies:

   pip install -r fastapi_app/requirements.txt

4. Install frontend dependencies:

   cd frontend
   npm install
   cd ..

5. Configure environment variables:
   • Create a file named .env in the root directory of the project (where render.yaml is).
   • Add your OpenRouter API key and other required variables:

     # Required: OpenRouter API key for AI processing
     OPENROUTER_API_KEY=your_openrouter_api_key
     
     # Required: Secret key for security (generate a secure random key)
     SECRET_KEY=your_secure_secret_key_here
     
     # Optional: Google API key for verification step
     GOOGLE_API_KEY=your_google_api_key_here
     
     # Optional: Application configuration
     APP_URL=http://localhost:8000
     APP_TITLE=trippleCheck
     
     # Optional: Frontend development
     VITE_FASTAPI_URL=http://127.0.0.1:8000

   • Replace the placeholder values with your actual keys.
   • Security Note: Never commit the .env file to version control. It's already in .gitignore.
6. Install Required System Dependencies:
   • Tesseract OCR for image processing
   • LibreOffice for document conversion (optional)
   • Unrar for RAR archive support (optional)
7. Run the application (Development Mode):
   • Terminal 1 (Backend):

     # Make sure your virtual environment is activated
     cd fastapi_app
     uvicorn app.main:app --reload --host 0.0.0.0 --port 8000

   • Terminal 2 (Frontend):

     cd frontend
     npm run dev

   • The application frontend will be available at http://localhost:5173 (or another port if 5173 is busy), and the backend API at http://127.0.0.1:8000.

Deployment (Render.com)

The application is configured for deployment on Render using a single web service.

• Configuration File: render.yaml defines the build and start commands.
• Build Process:
  1. Installs Python dependencies (fastapi_app/requirements.txt).
  2. Installs Node.js dependencies and builds the SvelteKit frontend (cd frontend && npm install && npm run build).
  3. Copies the built frontend static files into the FastAPI static directory (fastapi_app/app/static/dist/).
• Start Command: Uses Gunicorn to run the FastAPI application (cd fastapi_app && gunicorn ... app.main:app ...).
• Environment Variables on Render: You must set the OPENROUTER_API_KEY secret environment variable in the Render service settings. The PYTHON_VERSION is set in render.yaml.

Note on File Processing: Some file processing features may require additional system dependencies (Tesseract OCR, LibreOffice, etc.) which need to be installed separately on the deployment server.

Docker Deployment

The application can be deployed using Docker with secure environment variable management.

Prerequisites

• Docker and Docker Compose installed
• OpenRouter API key
• Secure secret key

Quick Start with Docker

1. Set environment variables:

   export OPENROUTER_API_KEY="your_actual_api_key"
   export SECRET_KEY="your_secure_secret_key"
   export GOOGLE_API_KEY="your_google_api_key"  # Optional

2. Build and run with Docker Compose:

   docker-compose up --build

3. Access the application:

   • Frontend: http://localhost:80
   • Backend API: http://localhost:8000

Security Features

• No sensitive data in images: Environment variables are injected at runtime
• Environment validation: Container validates required variables before startup
• Non-root user: Container runs as appuser instead of root
• Health checks: Built-in health monitoring

For detailed security guidelines, see docker/SECURITY.md.

Contributing

Please read our Contributing Guidelines for details on our code of conduct and the process for submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.