Update README and documentation; refactor frontend components for improved structure and resilience
This commit is contained in:
@@ -13,6 +13,7 @@ Python FastAPI service for integrating with external homelab services.
|
||||
- **Framework**: FastAPI
|
||||
- **Port**: 8000
|
||||
- **Message Bus**: Redis
|
||||
- **Documentation**: OpenAPI/Swagger
|
||||
|
||||
## Features
|
||||
- Home Assistant entity integration
|
||||
@@ -20,6 +21,35 @@ Python FastAPI service for integrating with external homelab services.
|
||||
- Immich asset management
|
||||
- n8n workflow triggers
|
||||
- Event publishing to Redis
|
||||
- Comprehensive OpenAPI documentation
|
||||
- Modular architecture for maintainability
|
||||
|
||||
## Project Structure
|
||||
```
|
||||
service-adapters/
|
||||
├── main.py # FastAPI application (40 lines)
|
||||
├── models/
|
||||
│ ├── schemas.py # Pydantic models
|
||||
├── routes/
|
||||
│ ├── general.py # Root, health, services
|
||||
│ ├── home_assistant.py # HA integration
|
||||
│ ├── frigate.py # Frigate integration
|
||||
│ ├── immich.py # Immich integration
|
||||
│ └── events.py # Event management
|
||||
└── services/
|
||||
├── config.py # Service configurations
|
||||
└── redis_client.py # Redis connection
|
||||
```
|
||||
|
||||
## API Endpoints
|
||||
- `GET /` - API information
|
||||
- `GET /health` - Health check
|
||||
- `GET /services` - Service status
|
||||
- `GET /home-assistant/entities` - HA entities
|
||||
- `GET /frigate/events` - Frigate events
|
||||
- `GET /immich/assets` - Immich assets
|
||||
- `POST /publish-event` - Publish events
|
||||
- `GET /events` - Retrieve events
|
||||
|
||||
## Development Status
|
||||
✅ **Complete** - Core functionality implemented
|
||||
✅ **Complete** - Core functionality implemented with modular architecture
|
||||
|
||||
Reference in New Issue
Block a user