BackendServer / README.md
Codegeass321's picture
HF Spaces
7036bcd
---
title: ChatDocxAI
emoji: πŸ“„
colorFrom: indigo
colorTo: blue
sdk: gradio
sdk_version: 4.19.2
app_file: app.py
pinned: false
---
# Backend (FastAPI with Gradio UI)
## Structure
- `api.py` β€” Main FastAPI app
- `app.py` β€” Gradio wrapper for FastAPI
- `utils.py` β€” Helper functions
- `requirements.txt` β€” Python dependencies
- `.env.example` β€” Example environment variables
## Port Configuration
- Single port (7860) with FastAPI mounted at the `/api` path
## API Endpoints
- **Upload Documents**: `https://codegeass321-backendserver.hf.space/api/upload`
- **Ask Questions**: `https://codegeass321-backendserver.hf.space/api/ask`
- **Check Status**: `https://codegeass321-backendserver.hf.space/api/status`
- **API Documentation**: `https://codegeass321-backendserver.hf.space/api/docs`
## Running Locally
```sh
pip install -r requirements.txt
python app.py
```
## Deploying to Hugging Face Spaces
1. Create a new Space with Gradio SDK
2. Upload this repository to the Space
3. Set the following environment variables in the Space settings:
- `GOOGLE_API_KEY` - Your Google Gemini API key
- `SUPABASE_URL` - Your Supabase URL
- `SUPABASE_KEY` - Your Supabase API key
## For Render (Legacy)
- Use the following start command on Render:
```
uvicorn api:app --host 0.0.0.0 --port 10000
```
```
- Add your environment variables in the Render dashboard
---
**Do not commit your real `.env` file! Use `.env.example` for reference.**
---