Update README and documentation; refactor frontend components for improved structure and resilience

This commit is contained in:
glenn schrooyen
2025-09-11 23:46:29 +02:00
parent 63b4bb487d
commit b9206de1a0
49 changed files with 27058 additions and 581 deletions

View File

@@ -68,6 +68,7 @@ docker-compose up -d
- Frontend: http://localhost:3000
- API Gateway: http://localhost:8080
- Service Adapters: http://localhost:8000
- API Documentation: http://localhost:8083
## Services
@@ -85,7 +86,7 @@ docker-compose up -d
### Frontend (React)
- **Port**: 3000
- **Purpose**: Dashboard UI
- **Features**: Real-time updates, customizable widgets, responsive design
- **Features**: Real-time updates, customizable widgets, responsive design, offline mode, clean code architecture
### Database (PostgreSQL)
- **Port**: 5432
@@ -97,19 +98,24 @@ docker-compose up -d
- **Purpose**: Inter-service communication
- **Features**: Event publishing, real-time updates
### API Documentation (Node.js)
- **Port**: 8083
- **Purpose**: Unified API documentation
- **Features**: Swagger UI, service health monitoring, dynamic spec generation
## Development
### Backend Development
#### Java API Gateway
```bash
cd backend/api-gateway
cd services/api-gateway
mvn spring-boot:run
```
#### Python Service Adapters
```bash
cd backend/service-adapters
cd services/service-adapters
pip install -r requirements.txt
uvicorn main:app --reload
```
@@ -145,6 +151,7 @@ npm start
## API Documentation
- **Unified Documentation**: http://localhost:8083
- **API Gateway**: http://localhost:8080/swagger-ui.html
- **Service Adapters**: http://localhost:8000/docs
@@ -152,8 +159,12 @@ npm start
- [x] Basic project structure and Docker setup
- [x] Spring Boot API gateway with authentication
- [x] FastAPI service adapters
- [x] FastAPI service adapters with modular structure
- [x] React frontend with dashboard
- [x] Unified API documentation service
- [x] OpenAPI/Swagger integration
- [x] Frontend clean code refactoring
- [x] Offline mode and error resilience
- [ ] Home Assistant integration
- [ ] Frigate integration
- [ ] Immich integration