Skip to content

fix: update non-existent apps/frontend paths to apps/dashboard and align docs #174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Devnil434 merged 2 commits into from
Jul 16, 2026
Merged

fix: update non-existent apps/frontend paths to apps/dashboard and align docs #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
801ef37
fix: update frontend paths in Makefile and ARCHITECTURE.md to apps/da…
Deepthit-23 Jun 19, 2026
c97fc8f
docs: update Next.js references to React/Vite in README and ARCHITECTURE
Deepthit-23 Jul 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ install:
# --------------------------------------------------------------------------
install-frontend:
@echo "Installing frontend dependencies..."
cd apps/frontend && npm install
cd apps/dashboard && npm install
@echo "Done: frontend dependencies installed."

# --------------------------------------------------------------------------
Expand Down
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![GSSoC 2026](https://img.shields.io/badge/GSSoC-2026-orange?style=for-the-badge&logo=github)](https://gssoc.girlscript.tech)
[![Python](https://img.shields.io/badge/Python-3.11+-blue?style=for-the-badge&logo=python)](https://python.org)
[![FastAPI](https://img.shields.io/badge/FastAPI-0.110+-green?style=for-the-badge&logo=fastapi)](https://fastapi.tiangolo.com)
[![Next.js](https://img.shields.io/badge/Next.js-14+-black?style=for-the-badge&logo=next.js)](https://nextjs.org)
[![React](https://img.shields.io/badge/React-19+-blue?style=for-the-badge&logo=react)](https://react.dev)

@coderabbitai coderabbitai Bot Jul 1, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Update the remaining consumer-facing references too.

The README now points to apps/dashboard/React, but the issue templates still send contributors to apps/frontend and Next.js. That leaves the repo in a mixed state and keeps the old path alive in user-facing flows.

Also applies to: 81-81, 94-94, 109-109, 324-324

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 10, The repo still has consumer-facing references to the
old frontend path and framework in the issue templates, creating inconsistent
guidance with the updated README. Update the affected template text and any
related user-facing references so they point to apps/dashboard and React instead
of apps/frontend and Next.js, using the existing template strings and labels to
locate the stale references.

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow?style=for-the-badge)](LICENSE)
[![PRs Welcome](https://img.shields.io/badge/PRs-Welcome-brightgreen?style=for-the-badge)](CONTRIBUTING.md)

Expand Down Expand Up @@ -78,7 +78,7 @@ The architecture covers:
- Detection → Tracking → Temporal Memory → Reasoning pipeline
- Event-triggered VLM execution
- Redis memory design
- FastAPI + Next.js integration
- FastAPI + React integration
- Full component and data-flow reference

### Service Breakdown
Expand All @@ -91,7 +91,7 @@ The architecture covers:
| **VLM Layer** | LLaVA-Next / Qwen-VL | Generate natural language frame descriptions on event trigger |
| **LLM Reasoning** | Mixtral / GPT-4o / Gemini | Classify intent from caption sequence; output label + reason |
| **Backend API** | FastAPI + Celery | Async REST API; task queue for slow VLM/LLM calls |
| **Frontend** | Next.js 14 + TypeScript | Live video, bounding box overlay, alert panel, timeline |
| **Frontend** | React 19 + TypeScript | Live video, bounding box overlay, alert panel, timeline |

---

Expand All @@ -106,7 +106,7 @@ The architecture covers:
| LLM Reasoning | Mixtral-8x7B / GPT-4o | Configurable per cost/quality requirements |
| Backend | FastAPI + Uvicorn | Async, auto-docs, Pydantic, fastest Python API |
| Task Queue | Celery + Redis | Decouples slow VLM/LLM from real-time pipeline |
| Frontend | Next.js 14 + TypeScript | App Router, SSE, type safety, Tailwind |
| Frontend | React 19 + Vite | Vite dev server, SSE, type safety, Tailwind |
| Containers | Docker + docker-compose | One-command setup for all contributors |
| CI/CD | GitHub Actions | Free for open source; native GitHub integration |
| Optimization | ONNX Runtime (INT8) | 2–4× speed-up without retraining |
Expand Down Expand Up @@ -321,7 +321,7 @@ Request: { "alert_id": "alert_001", "correct": false, "note": "Normal employee"
| Week 4 | VLM | LLaVA-Next producing frame captions on event trigger |
| Week 5 | LLM Reasoning | Caption sequence → Suspicious/Normal + explanation |
| Week 6 | API | FastAPI live; all endpoints tested; Docker working |
| Week 7 | Frontend | Next.js dashboard with live video, alerts, timeline |
| Week 7 | Frontend | React dashboard with live video, alerts, timeline |
| Week 8 | Launch | Optimized, documented, CI live, 20+ GSSoC issues |

**Post-GSSoC (v2.0+):**
Expand Down
6 changes: 3 additions & 3 deletions docs/ARCHITECTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Eagle Architecture Reference

Eagle is an event-driven surveillance reasoning pipeline that converts raw video frames into natural-language risk assessments. Frames enter the detection layer (`services/detection/detector.py`), tracked entities are persisted across time (`services/tracking/tracker.py`), recent events are stored in Redis (`services/memory/memory.py`), and only meaningful behavioral changes trigger multimodal reasoning (`services/reasoning/vlm.py` + `services/reasoning/llm.py`). The final output is a structured alert served through the FastAPI backend (`apps/backend/main.py`) and visualized in the Next.js dashboard (`apps/frontend/`).
Eagle is an event-driven surveillance reasoning pipeline that converts raw video frames into natural-language risk assessments. Frames enter the detection layer (`services/detection/detector.py`), tracked entities are persisted across time (`services/tracking/tracker.py`), recent events are stored in Redis (`services/memory/memory.py`), and only meaningful behavioral changes trigger multimodal reasoning (`services/reasoning/vlm.py` + `services/reasoning/llm.py`). The final output is a structured alert served through the FastAPI backend (`apps/backend/main.py`) and visualized in the React dashboard (`apps/dashboard/`).

---

Expand All @@ -14,7 +14,7 @@ Eagle is an event-driven surveillance reasoning pipeline that converts raw video
| VLM Captioning | LLaVA-Next / Qwen-VL | Triggered frame sequence | Natural language captions |
| LLM Reasoning | Mixtral / GPT-4o / Gemini | Caption sequence + policies | `Alert(label, confidence, reason)` |
| Backend API | FastAPI + Celery | REST requests | JSON API responses |
| Frontend | Next.js 14 | SSE / REST payloads | Live dashboard + alert timeline |
| Frontend | React 19 + Vite | SSE / REST payloads | Live dashboard + alert timeline |

---

Expand All @@ -38,4 +38,4 @@ F --> G[LLM Reasoning<br/>services/reasoning/llm.py]

G --> H[FastAPI Backend<br/>apps/backend/main.py]

H --> I[Next.js Dashboard<br/>apps/frontend]
H --> I[React Dashboard<br/>apps/dashboard]
Loading