GitHub Guide

Information about the Ath AI Assistant repository, project structure, and how to contribute.

Project Structure

The repository is organized into a modular structure to separate concerns between the real-time backend and the interactive frontend.

ath-assistant/
├── backend/
│   ├── server.py        # FastAPI server & WebSocket logic
│   ├── requirements.txt # Python dependencies
│   └── .env             # Configuration secrets
└── frontend/
    ├── about.html       # Landing page
    ├── auth.html        # Login/Signup flow
    ├── index.html       # Main application
    └── app.js           # Frontend logic & WebSocket client

Local Development

To run the project locally for development:

  1. Create a virtual environment: python -m venv .venv
  2. Activate it and install dependencies: pip install -r requirements.txt
  3. Configure your .env file with Supabase and AWS credentials.
  4. Start the backend: python server.py
  5. Open http://localhost:8000 in your browser.