{"id":28707837,"url":"https://github.com/myui/fairque-dashboard","last_synced_at":"2025-06-14T17:32:46.021Z","repository":{"id":298009191,"uuid":"998237751","full_name":"myui/fairque-dashboard","owner":"myui","description":"Dashboard for monitoring and managing FairQueue task processing system.","archived":false,"fork":false,"pushed_at":"2025-06-08T07:00:28.000Z","size":47,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-08T23:02:12.630Z","etag":null,"topics":["dashboard","fairque","frontend","job-queue","job-scheduler","python","task-manager","task-queue","task-scheduler"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/myui.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-08T06:58:33.000Z","updated_at":"2025-06-08T07:02:03.000Z","dependencies_parsed_at":"2025-06-08T23:02:14.428Z","dependency_job_id":"09b32b03-d4df-4621-b957-8ebaf9b96065","html_url":"https://github.com/myui/fairque-dashboard","commit_stats":null,"previous_names":["myui/fairque-dashboard"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/myui/fairque-dashboard","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/myui%2Ffairque-dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/myui%2Ffairque-dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/myui%2Ffairque-dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/myui%2Ffairque-dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/myui","download_url":"https://codeload.github.com/myui/fairque-dashboard/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/myui%2Ffairque-dashboard/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259854008,"owners_count":22921958,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dashboard","fairque","frontend","job-queue","job-scheduler","python","task-manager","task-queue","task-scheduler"],"created_at":"2025-06-14T17:30:39.964Z","updated_at":"2025-06-14T17:32:46.011Z","avatar_url":"https://github.com/myui.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FairQueue Dashboard\n\nA comprehensive web-based dashboard for monitoring and managing FairQueue task processing system.\n\n## Features\n\n- **Worker Management**: Monitor worker status, start/stop workers, view performance metrics\n- **Queue Management**: View queue statistics, manage queue operations\n- **Task Management**: Advanced task filtering, state management, retry operations\n- **Pipeline Visualization**: Simple flow visualization for task pipelines\n- **XCom Data Management**: View and manage task data exchange\n- **Real-time Metrics**: Live dashboard with system health indicators\n\n## Architecture\n\n- **Backend**: FastAPI with async Redis integration\n- **Frontend**: React with TypeScript and Material-UI\n- **Database**: Redis for both FairQueue data and dashboard state\n- **Real-time Updates**: WebSocket connections for live metrics\n\n## Development Setup\n\n### Prerequisites\n\n- Python 3.11+\n- Node.js 18+\n- Redis server\n- Docker \u0026 Docker Compose (optional)\n\n### Local Development\n\n1. **Backend Setup**\n   ```bash\n   cd backend\n   pip install uv\n   uv pip install -e .\n   uvicorn fairque_dashboard.main:app --reload --host 0.0.0.0 --port 8080\n   ```\n\n2. **Frontend Setup**\n   ```bash\n   cd frontend\n   npm install\n   npm run dev\n   ```\n\n3. **Redis Setup**\n   ```bash\n   # Install and start Redis locally\n   redis-server\n   ```\n\n### Docker Development\n\n```bash\n# Start all services\ndocker-compose up -d\n\n# View logs\ndocker-compose logs -f\n\n# Stop services\ndocker-compose down\n```\n\n## Configuration\n\n### Backend Environment Variables\n\n- `FAIRQUE_DASHBOARD_FAIRQUE_REDIS_URL`: Redis connection for FairQueue data\n- `FAIRQUE_DASHBOARD_DEBUG`: Enable debug mode\n- `FAIRQUE_DASHBOARD_HOST`: Server host (default: 0.0.0.0)\n- `FAIRQUE_DASHBOARD_PORT`: Server port (default: 8080)\n\n### Frontend Environment Variables\n\n- `VITE_API_BASE_URL`: Backend API URL (default: http://localhost:8080/api/v1)\n\n## API Endpoints\n\n### Workers\n- `GET /api/v1/workers` - List workers\n- `GET /api/v1/workers/{worker_id}` - Get worker details\n- `POST /api/v1/workers/{worker_id}/start` - Start worker\n- `POST /api/v1/workers/{worker_id}/stop` - Stop worker\n- `POST /api/v1/workers/{worker_id}/restart` - Restart worker\n\n### Tasks\n- `GET /api/v1/tasks` - List tasks with filtering\n- `GET /api/v1/tasks/{task_id}` - Get task details\n- `POST /api/v1/tasks/{task_id}/cancel` - Cancel task\n- `POST /api/v1/tasks/{task_id}/retry` - Retry task\n- `DELETE /api/v1/tasks/{task_id}` - Delete task\n\n### Queues\n- `GET /api/v1/queues` - List queues\n- `GET /api/v1/queues/{queue_name}` - Get queue details\n- `POST /api/v1/queues/{queue_name}/pause` - Pause queue\n- `POST /api/v1/queues/{queue_name}/resume` - Resume queue\n- `DELETE /api/v1/queues/{queue_name}` - Delete queue\n\n### Metrics\n- `GET /api/v1/metrics` - Get system metrics\n- `GET /api/v1/metrics/workers` - Get worker metrics\n- `GET /api/v1/metrics/queues` - Get queue metrics\n- `GET /api/v1/metrics/tasks` - Get task metrics\n\n### WebSocket\n- `WS /api/v1/ws/metrics` - Real-time metrics updates\n- `WS /api/v1/ws/tasks` - Real-time task updates\n\n## Usage\n\n1. **Dashboard**: Overview of system health and metrics\n2. **Tasks**: Filter, search, and manage tasks\n3. **Workers**: Monitor and control worker processes\n4. **Queues**: View queue statistics and manage operations\n5. **Pipelines**: Visualize task workflow execution\n6. **XCom**: Manage task data exchange\n\n## Development Guidelines\n\n### Code Style\n- Backend: Follow PEP 8, use type hints\n- Frontend: Use TypeScript, functional components, Material-UI\n\n### Testing\n```bash\n# Backend tests\ncd backend\npytest\n\n# Frontend tests  \ncd frontend\nnpm test\n```\n\n### Contributing\n\n1. Follow the existing code style\n2. Add tests for new features\n3. Update documentation\n4. Use descriptive commit messages\n\n## License\n\nMIT License","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmyui%2Ffairque-dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmyui%2Ffairque-dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmyui%2Ffairque-dashboard/lists"}