{"id":28443306,"url":"https://github.com/delt4d/echo","last_synced_at":"2025-06-29T12:32:25.089Z","repository":{"id":290835070,"uuid":"975665105","full_name":"delt4d/Echo","owner":"delt4d","description":"User interactions recorder and mimic.","archived":false,"fork":false,"pushed_at":"2025-05-26T17:18:25.000Z","size":288,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-06T07:11:27.798Z","etag":null,"topics":["csharp","css","dotnet","echo","html","interactions","javascript","mimic","nodejs","recording"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/delt4d.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-04-30T17:31:37.000Z","updated_at":"2025-06-03T03:57:25.000Z","dependencies_parsed_at":"2025-05-26T18:23:50.542Z","dependency_job_id":"8db8abcf-d13e-4a9a-aa3e-0dde7222643f","html_url":"https://github.com/delt4d/Echo","commit_stats":null,"previous_names":["delt4d/echo"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/delt4d/Echo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delt4d%2FEcho","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delt4d%2FEcho/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delt4d%2FEcho/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delt4d%2FEcho/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/delt4d","download_url":"https://codeload.github.com/delt4d/Echo/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delt4d%2FEcho/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262593929,"owners_count":23334089,"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":["csharp","css","dotnet","echo","html","interactions","javascript","mimic","nodejs","recording"],"created_at":"2025-06-06T07:11:10.410Z","updated_at":"2025-06-29T12:32:25.057Z","avatar_url":"https://github.com/delt4d.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Echo\n\n[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/delt4d/Echo)\n\n**Echo** is a session recording and replay system that enables the capture and visual reproduction of user interactions in websites.\nIt consists of client-side code to capture user interactions in real-time, and server-side code to save and retrieve user interactions.\n\n```\nEcho/\n├── Docs/               # Images and documents to be used by README\n├── Echo.run/           # Runtime configuration files (e.g., launch profiles)\n├── Lib/                # Shared client and server libraries\n├── Preview/            # Server and client for preview of recording and mimic\n├── .gitignore          # Files and folders to ignore in version control\n├── Back.Dockerfile     # Docker configuration to the preview server\n├── Front.Dockerfile    # Docker configuration to the preview client\n├── docker-compose.yml  # Configuration to run both containers \n└── echo.sln            # .NET solution file\n```\n\n## Features\n- Real-Time Recording: Capture user interactions as they occur.\n- Accurate Replay: Reproduce user sessions within an iframe for analysis.\n- Privacy Controls: Implement data masking to protect sensitive user information during recording and playback.\n\n## Use Cases\n- Bug Reproduction: Developers can replay exact user flows that led to errors.\n- UX Analysis: Product teams can visualize how users interact with interfaces.\n- Compliance: With data masking, user sessions can be analyzed securely.\n\n## Server Components\nThe server side of Echo consists of the following main components:\n\n- **EchoServer:** A .NET application that hosts the SignalR hub and manages the connection with clients.\n- **EchoLib:** A .NET library that provides core functionality used by the server. \n- **SignalR Hub:** Facilitates real-time, bidirectional communication between the server and clients.\n\n## Client Components\nThe client side includes:\n\n- **EchoMimic:** A component responsible for replaying recorded user interactions within an iframe.\n- **EchoRecorder:** Captures user interactions and prepares them for transmission.\n- **EchoData:** A data structure representing captured events.\n- **Event Handlers:** A collection of specialized handlers for different types of user interactions.\n\n## Data Flow\nEcho processes data through two main pipelines:\n\n### Recording Pipeline\n- User interactions are captured by specialized event handlers.\n- Captured events are converted into standardized EchoData objects.\n- EchoData objects are transmitted to the server via SignalR.\n- The server, utilizing EchoLib, saves the received events for future replay.\n\n### Replay Pipeline\n- The EchoMimic component receives events from the server through a SignalR connection.\n- Events are queued and processed sequentially.\n- Processed events are visually reproduced within an iframe element.\n\n## Quick Start\n\n```bash\n# Clone project\ngit clone https://github.com/delt4d/Echo.git\n\n# Build and start the client\ncd Echo/Lib/Client\nnpm install\nnpm run build\n\n# Run the preview server\ncd Echo/Preview/Server\ndotnet run\n\n# Run the preview client\ncd Echo/Preview/Client\nnpm install\nnpm run start\n```\n\n## Preview\nEnsure both the server and client preview applications are running.\nOpen [`http://localhost:5500/recorder`](http://localhost:5500/recorder) and perform actions like moving the mouse or typing.\nThen navigate to [`http://localhost:5500/mimic`](http://localhost:5500/mimic) to watch your session replayed inside an iframe.\n\n![Preview.gif](Docs/Preview.gif)\n\n## Usage\nBuild the client library, move `dist/` contents to the website folder and reference it in a script tag.\n```html\n\u003c!-- Make sure this script is loaded before using \u003cecho-mimic\u003e --\u003e\n\u003cscript src=\"{directory_location}/echo/index.js\"\u003e\u003c/script\u003e\n```\n\n🎥 Start Recording (Client)\nTo capture and stream user interactions in real-time:\n\n```javascript\nconst echoRecorder = new EchoRecorder();\n\nfor await (const echoData of echoRecorder.getChangesAsync()) {\n    const data = echoData.toJson();\n    // Send `data` to your server or process it directly\n}\n```\nEach echoData is a structured event representing user activity.\n\n🔁 Replay a Session (Client)\nYou can replay a recorded session using the `\u003cecho-mimic\u003e` custom element:\n```html\n\u003cecho-mimic id=\"player\"\u003e\u003c/echo-mimic\u003e\n```\n\nIn Javascript:\n\n```javascript\nconst echoMimic = new EchoMimic(document.getElementById(\"player\"));\n\n// Option 1: Queue events to be executed sequentially\nawait echoMimic.enqueueAsync(EchoData.fromJson(data));\n\n// Option 2: Execute immediately (useful for testing or manual control)\nawait echoMimic.executeAsync(EchoData.fromJson(data));\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdelt4d%2Fecho","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdelt4d%2Fecho","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdelt4d%2Fecho/lists"}