Add comprehensive README with full project documentation#3
Merged
Conversation
Covers hardware setup, instructor/student session flow, system architecture, Socket.IO event reference, Eagle AI tiers, frontend structure, and self-hosting/deployment notes. https://claude.ai/code/session_0158sKVSLNZZesgY2NtqpKB2
There was a problem hiding this comment.
Pull request overview
Adds a substantially expanded top-level README intended to document EagleVision’s classroom workflow and overall system (hardware setup, session flow, architecture, and self-hosting notes) so new contributors/users can understand how the static frontend connects to the backend + LiveKit.
Changes:
- Replaces the minimal README with end-to-end product and architecture documentation (hardware, session flow, system diagram, Socket.IO events).
- Documents frontend file structure and core workspace capabilities (annotations, image adjustments, Eagle AI).
- Adds deployment/self-hosting and local development guidance, plus configuration constants and tech stack.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ``` | ||
| 1. Browser connects to api.eaglevision.dev via Socket.IO | ||
| 2. Browser emits join_room { code, username } |
| - Optionally click the key icon and enter an **admin key** to join as instructor | ||
| - Press Enter to move between fields, or click **Join Session** | ||
|
|
||
| The page stores session details in `sessionStorage` and redirects to the workspace. If you navigate to the workspace directly without a code, you'll be sent back to the join page. |
| 2. Start the instructor-side broadcasting client (separate from this frontend) | ||
| 3. The backend generates a **6-digit session code** for your room | ||
| 4. Share that code with your students | ||
| 5. When prompted, enter your **admin key** on the session join page to unlock instructor controls |
|
|
||
| - Enter the **session code** (6 digits) | ||
| - Enter your **name** | ||
| - Optionally click the key icon and enter an **admin key** to join as instructor |
| **POST `/api/ai/analyze`** | ||
| ```json | ||
| { | ||
| "password": "EagleDemo2026", |
| **POST `/api/ai/custom-question`** *(Pro only)* | ||
| ```json | ||
| { | ||
| "password": "EaglePro2026", |
Comment on lines
+222
to
+223
| | Basic | `EagleDemo2026` | Quick ID, Standard analysis | | ||
| | Pro | `EaglePro2026` | Quick ID, Standard, Detailed, Custom questions | |
Comment on lines
+282
to
+283
| const EAGLE_BASIC_PASSWORD = "EagleDemo2026"; | ||
| const EAGLE_PRO_PASSWORD = "EaglePro2026"; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Covers hardware setup, instructor/student session flow, system architecture, Socket.IO event reference, Eagle AI tiers, frontend structure, and self-hosting/deployment notes.