Hwandji commited on
Commit
182e12f
Β·
1 Parent(s): 73e945d

docs: Add HF Spaces metadata to README

Browse files
Files changed (1) hide show
  1. README.md +36 -19
README.md CHANGED
@@ -1,35 +1,47 @@
 
 
 
 
 
 
 
 
 
 
1
  # SAAP - satware AI Autonomous Agent Platform
2
 
3
- **Hugging Face Deployment** - Simple Docker setup with FastAPI serving both backend and frontend.
4
 
5
- ## πŸš€ Quick Start
6
 
7
- This application runs on Hugging Face Spaces using a single Docker container with:
8
- - **FastAPI backend** (Python 3.11)
9
- - **Vue.js frontend** (served as static files)
10
- - **Port 7860** (Hugging Face Spaces default)
 
11
 
12
- ## 🐳 Architecture
13
 
14
- - **Dockerfile**: Single-stage build that compiles frontend and starts FastAPI
15
- - **Backend**: `/app/backend/` - FastAPI server with agent management
16
- - **Frontend**: `/app/frontend/dist/` - Pre-built Vue.js app served by FastAPI
 
17
 
18
  ## πŸ“‘ API Endpoints
19
 
20
- - `GET /` - Vue.js frontend (static files)
21
- - `GET /api` - API status
22
  - `GET /api/v1/agents` - List all agents
23
- - `POST /api/v1/agents/{id}/chat` - Chat with agent
24
- - `GET /docs` - Interactive API documentation
25
 
26
- ## πŸ”§ Development
27
 
28
  ```bash
29
  # Backend
30
  cd backend
31
  pip install -r requirements.txt
32
- uvicorn main:app --reload
33
 
34
  # Frontend
35
  cd frontend
@@ -37,10 +49,15 @@ npm install
37
  npm run dev
38
  ```
39
 
40
- ## πŸ“¦ Deployment
41
 
42
- Deployed on [Hugging Face Spaces](https://huggingface.co/spaces/Hwandji/saap-huggingface)
 
 
 
 
43
 
44
  ---
45
 
46
- Built with ❀️ by satware AG
 
 
1
+ ---
2
+ title: SAAP - satware AI Platform
3
+ emoji: πŸ€–
4
+ colorFrom: blue
5
+ colorTo: purple
6
+ sdk: docker
7
+ pinned: false
8
+ app_port: 7860
9
+ ---
10
+
11
  # SAAP - satware AI Autonomous Agent Platform
12
 
13
+ **Multi-Agent AI Platform** - FastAPI backend + Vue.js frontend running on Hugging Face Spaces.
14
 
15
+ ## πŸš€ Features
16
 
17
+ - **Multi-Agent Management**: Create and manage AI agents with different personalities
18
+ - **OpenRouter Integration**: Connect to various LLM models (GPT-4, Claude, etc.)
19
+ - **Real-time Chat**: WebSocket-based communication with agents
20
+ - **Cost Tracking**: Monitor API usage and costs
21
+ - **Modern UI**: Vue.js frontend with Tailwind CSS
22
 
23
+ ## πŸ—οΈ Architecture
24
 
25
+ - **Backend**: FastAPI (Python 3.11) serving API and static files
26
+ - **Frontend**: Vue.js + Vite (pre-built, served as static files)
27
+ - **Port**: 7860 (Hugging Face Spaces default)
28
+ - **Database**: SQLite for agent configurations
29
 
30
  ## πŸ“‘ API Endpoints
31
 
32
+ - `GET /` - Vue.js frontend
33
+ - `GET /api` - API health check
34
  - `GET /api/v1/agents` - List all agents
35
+ - `POST /api/v1/agents/{id}/chat` - Chat with specific agent
36
+ - `GET /docs` - Interactive API documentation (Swagger UI)
37
 
38
+ ## πŸ”§ Local Development
39
 
40
  ```bash
41
  # Backend
42
  cd backend
43
  pip install -r requirements.txt
44
+ uvicorn main:app --reload --port 8000
45
 
46
  # Frontend
47
  cd frontend
 
49
  npm run dev
50
  ```
51
 
52
+ ## 🌐 Deployment
53
 
54
+ This version is optimized for Hugging Face Spaces:
55
+ - Single Dockerfile with multi-stage build
56
+ - FastAPI serves both API and frontend
57
+ - No nginx or supervisord required
58
+ - Environment variables via HF Secrets
59
 
60
  ---
61
 
62
+ **Built with ❀️ by satware AG**
63
+ Master Thesis Project - Applied Computer Science