{"id":23438490,"url":"https://github.com/engineering87/reactive-orb","last_synced_at":"2026-04-02T18:53:41.765Z","repository":{"id":269315701,"uuid":"907039849","full_name":"engineering87/reactive-orb","owner":"engineering87","description":"An Interactive Orb Animation for REST API","archived":false,"fork":false,"pushed_at":"2025-04-03T15:03:19.000Z","size":3815,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-03T16:21:57.593Z","etag":null,"topics":["animation","api","dotnet-core","react","signalr"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/engineering87.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2024-12-22T16:37:01.000Z","updated_at":"2025-04-03T15:02:12.000Z","dependencies_parsed_at":"2024-12-22T17:30:57.273Z","dependency_job_id":"5637c859-1ca3-4c75-ac55-67e8d5ba6c7d","html_url":"https://github.com/engineering87/reactive-orb","commit_stats":null,"previous_names":["engineering87/reactive-orb"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineering87%2Freactive-orb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineering87%2Freactive-orb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineering87%2Freactive-orb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineering87%2Freactive-orb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/engineering87","download_url":"https://codeload.github.com/engineering87/reactive-orb/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248097947,"owners_count":21047341,"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":["animation","api","dotnet-core","react","signalr"],"created_at":"2024-12-23T14:49:44.761Z","updated_at":"2025-12-30T23:05:08.664Z","avatar_url":"https://github.com/engineering87.png","language":"JavaScript","readme":"# ReactiveOrb: An Interactive Orb Animation for REST API\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![issues - reactive-orb](https://img.shields.io/github/issues/engineering87/reactive-orb)](https://github.com/engineering87/reactive-orb/issues)\n[![stars - reactive-orb](https://img.shields.io/github/stars/engineering87/reactive-orb?style=social)](https://github.com/engineering87/reactive-orb)\n\n## Overview\n\nThis project is an experimental implementation that explores the interaction between **REST APIs** and **advanced graphical animations** using a dynamic **orb (sphere)**. The sphere changes its appearance and behavior in real-time based on **SignalR events** received from the API, and responds to different **HTTP methods** invoked on the API (such as `GET`, `POST`, `PUT`, and `DELETE`).\n\nThe project uses **WART** to send **SignalR** messages from the backend REST API to the frontend, allowing the sphere to visually react to the API's state and the type of HTTP requests being processed.\n\n![Alt text](https://github.com/engineering87/reactive-orb/blob/main/ReactiveOrbDemo.gif)\n\n## Features\n\n- **Real-Time Animation**: The orb changes color and undergoes distortion effects based on incoming events.\n- **SignalR Integration**: Real-time communication between the backend REST API and the frontend is powered by SignalR.\n- **Dynamic Color Change**: Different HTTP methods (`POST`, `GET`, `PUT`, `DELETE`) are mapped to specific colors, which are displayed on the orb.\n- **Interactive Visualization**: The sphere responds to the frequency and type of events, creating an engaging visualization that simulates the backend activity.\n- **Event-Driven Animation**: The orb adapts its appearance as a reaction to changes in the API's state, with smooth transitions and a multi-color effect when multiple event types occur.\n\n## How It Works\n\n1. **SignalR Communication**: The project leverages the **SignalR** library for real-time communication between the backend (REST API) and the frontend (React.js).\n   \n2. **Backend - WART Integration**: The backend REST API is configured to send **SignalR messages** using the **[WART library](https://github.com/engineering87/WART)**. Each HTTP request (`POST`, `GET`, `PUT`, `DELETE`) triggers a SignalR event that informs the frontend of the method type.\n\n3. **Frontend - React.js + Three.js**: The frontend is built using **React.js** and **Three.js**. A 3D sphere (orb) is rendered and animated in the canvas, where:\n   - The **color** of the sphere changes based on the HTTP method used.\n   - **Distortion** and **speed** of the animation are adjusted dynamically, based on the frequency and type of events received.\n\n4. **Event-driven Animation**: The orb reacts in real-time to events:\n   - Each event changes the sphere's **color** (e.g., `POST` turns it green, `PUT` turns it yellow, etc.).\n   - The **distortion effect** becomes more intense as more events are received, but is capped to prevent excessive distortion.\n   - If no events are received for a certain period (e.g., 5 seconds), the sphere returns to its original state.\n\n## Setup\n\n### Prerequisites\n\nBefore running the project, ensure you have the following installed:\n- **Node.js** (v16 or later)\n- **npm** or **yarn**\n- **WART library** (for backend integration)\n\n### Installation\n\n1. Clone the repository:\n\n    ```bash\n    git clone https://github.com/your-username/interactive-orb.git\n    cd interactive-orb\n    ```\n\n2. Install frontend dependencies:\n\n    ```bash\n    npm install\n    # or if you're using yarn\n    yarn install\n    ```\n\n3. Set up the backend REST API to use **WART** for sending SignalR messages:\n   - Integrate WART into your backend application. Follow the instructions on the [WART repository](https://github.com/engineering87/WART) to configure SignalR communication.\n\n4. Start the development server:\n\n    ```bash\n    npm start\n    # or if you're using yarn\n    yarn start\n    ```\n\n   The frontend will be available at `http://localhost:3000`.\n\n### Running the Backend (SignalR)\n\n1. Set up and run the backend that emits SignalR messages (using the WART library) based on HTTP requests:\n   - Send events via SignalR for `POST`, `GET`, `PUT`, and `DELETE` requests.\n   - The frontend will react to these events, updating the orb accordingly.\n     \n## Libraries Used\n\n- **React.js**: Frontend library for building the user interface.\n- **Three.js**: 3D rendering library used to create the animated sphere.\n- **SignalR**: Real-time web functionality for pushing events from the backend to the frontend.\n- **WART**: Library for sending SignalR messages from the REST API (backend).\n\n## Example Usage\n\n1. Send a `POST` request to the backend:\n\n   - The sphere will turn **green** (associated with `POST`).\n   - Distortion and intensity increase, depending on the frequency of events.\n\n2. Send a `PUT` request to the backend:\n\n   - The sphere will turn **yellow** (associated with `PUT`).\n   - The distortion effect changes accordingly.\n\n3. The sphere will dynamically adjust as different events are sent.\n\n### Contributing\nThank you for considering to help out with the source code!\nIf you'd like to contribute, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base.\n\n**Getting started with Git and GitHub**\n\n * [Setting up Git](https://docs.github.com/en/get-started/getting-started-with-git/set-up-git)\n * [Fork the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)\n * [Open an issue](https://github.com/engineering87/reactive-orb/issues) if you encounter a bug or have a suggestion for improvements/features\n\n### Licensee\nReactiveOrb source code is available under MIT License, see license in the source.\n\n### Contact\nPlease contact at francesco.delre[at]protonmail.com for any details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fengineering87%2Freactive-orb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fengineering87%2Freactive-orb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fengineering87%2Freactive-orb/lists"}