{"id":22741807,"url":"https://github.com/http-apis/hydra-python-agent-gui","last_synced_at":"2025-04-14T07:23:17.230Z","repository":{"id":35484627,"uuid":"201459540","full_name":"HTTP-APIs/hydra-python-agent-gui","owner":"HTTP-APIs","description":"GUI for the hydra python agent","archived":false,"fork":false,"pushed_at":"2023-01-27T10:02:47.000Z","size":7709,"stargazers_count":20,"open_issues_count":24,"forks_count":40,"subscribers_count":7,"default_branch":"develop","last_synced_at":"2025-04-11T22:23:10.441Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/HTTP-APIs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-09T12:03:01.000Z","updated_at":"2022-03-29T03:58:08.000Z","dependencies_parsed_at":"2023-02-15T07:46:34.044Z","dependency_job_id":null,"html_url":"https://github.com/HTTP-APIs/hydra-python-agent-gui","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HTTP-APIs%2Fhydra-python-agent-gui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HTTP-APIs%2Fhydra-python-agent-gui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HTTP-APIs%2Fhydra-python-agent-gui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HTTP-APIs%2Fhydra-python-agent-gui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HTTP-APIs","download_url":"https://codeload.github.com/HTTP-APIs/hydra-python-agent-gui/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248837592,"owners_count":21169463,"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":[],"created_at":"2024-12-11T00:17:56.449Z","updated_at":"2025-04-14T07:23:17.186Z","avatar_url":"https://github.com/HTTP-APIs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Hydra Agent GUI\nThis is a GUI for the [Hydra Ecosystem's Agent](https://github.com/HTTP-APIs/hydra-python-agent). It's divided in two parts: the left side shows the Hydra API as a linked graph and at the right you have a generic console built based on the API Documentation  that you can use to query the API. The Frontend was built with React, a middle layer to use the Agent was built with Flask.\n\n![Agent GUI Picture](/console-frontend/src/assets/images/agent_gui.png)\n\n### Installing Requirements\nIt's recommended that you use venv(virtual environment):\n\n```\nsudo apt-get install python3-venv # If not installed\npython3 -m venv venv\nsource venv/bin/activate\npip3 install -r requirements.txt\n```\n\n### Running Redis Graph \nThe Agent uses a Redis local server as a caching layer. That said, it's necessary that you run Redis Graph locally:\n\n```\nsudo ./redis_setup.sh # \u003c- Might be necessary to uso sudo\n```\n### Running hydrus server\nSince this is an API Client, we need an appropriate hydrus server to query to. To setup a localhost follow the instructions at https://github.com/HTTP-APIs/hydrus#demo. \n\n\n### Running the GUI\nIf you've installed the Requirements and have the proper Redis running you can simply:\n```\npython3 app.py\n```\n\n**Now open your browser and enjoy at:** [http://localhost:3000/](http://localhost:3000/ \"http://localhost:3000/\")\n\n### Contributing to the GUI\n\nThis repository is divided in two parts, the Middle-Layer/Backend with Flask under ```app.py``` and the React project under the folder ```console-frontend```. \n\n**The Flask Backend** is built to communicate with the Python Agent package. It declares five endpoints which are used for this:\n\n- **send-command** - Send Commands to Agent and returns the server response\n- **/hydra-doc** - Simply serves the Hydra Doc \n- **apidoc-graph** - Fetches Hydra Doc from the Agent, process it in Vis.js Network format and returns it to the GUI\n- **/start-agent** - Simply starts/restarts the Agent with the URL parameter \n- **/** - Serves the React build under /console-frontend/build\n\n**The React Frontend**\n\nGo the the README.md inside ```console-frontend``` for further information. If you make modifications inside ```console-frontend```, make sure to run ```npm run build``` to create a updated production build. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhttp-apis%2Fhydra-python-agent-gui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhttp-apis%2Fhydra-python-agent-gui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhttp-apis%2Fhydra-python-agent-gui/lists"}