{"id":13506077,"url":"https://github.com/Engineering-Research-and-Development/iotagent-ui","last_synced_at":"2025-03-30T03:30:30.254Z","repository":{"id":221158614,"uuid":"741406135","full_name":"Engineering-Research-and-Development/iotagent-ui","owner":"Engineering-Research-and-Development","description":"Web User Interface for IoTAgents based on iotagent-node-lib","archived":false,"fork":false,"pushed_at":"2024-12-04T15:06:28.000Z","size":196,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-22T17:26:15.858Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Engineering-Research-and-Development.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-01-10T10:28:05.000Z","updated_at":"2024-12-04T15:08:55.000Z","dependencies_parsed_at":"2024-10-28T11:22:33.373Z","dependency_job_id":"5eec5904-e8b5-4002-9d20-b744225bf1fe","html_url":"https://github.com/Engineering-Research-and-Development/iotagent-ui","commit_stats":null,"previous_names":["engineering-research-and-development/iotagent-ui"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Engineering-Research-and-Development%2Fiotagent-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Engineering-Research-and-Development%2Fiotagent-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Engineering-Research-and-Development%2Fiotagent-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Engineering-Research-and-Development%2Fiotagent-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Engineering-Research-and-Development","download_url":"https://codeload.github.com/Engineering-Research-and-Development/iotagent-ui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246273533,"owners_count":20750904,"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-08-01T01:00:34.196Z","updated_at":"2025-03-30T03:30:30.247Z","avatar_url":"https://github.com/Engineering-Research-and-Development.png","language":"TypeScript","funding_links":[],"categories":["Open-Source FIWARE from third parties"],"sub_categories":["Processing"],"readme":"# IoT Agent UI: the FIWARE IoT Agent Web UI for IoT Agents\n\n[![FIWARE IoT Agents](https://nexus.lab.fiware.org/static/badges/chapters/iot-agents.svg)](https://www.fiware.org/developers/catalogue/)\n[![License: AGPL](https://img.shields.io/github/license/Engineering-Research-and-Development/iotagent-ui.svg)](https://opensource.org/licenses/AGPL-3.0)\n[![Docker badge](https://img.shields.io/badge/quay.io-fiware%2Fiotagent--ui-grey?logo=red%20hat\u0026labelColor=EE0000)](https://quay.io/repository/fiware/iotagent-ui)\n[![Support badge](https://img.shields.io/badge/support-stackoverflow-orange)](https://stackoverflow.com/questions/tagged/fiware+iot)\u003cbr/\u003e\n![Status](https://nexus.lab.fiware.org/static/badges/statuses/incubating.svg)\n[![Join the chat at https://gitter.im/iotagent-ui/community](https://badges.gitter.im/iotagent-ui/community.svg)](https://gitter.im/iotagent-ui/community?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\u003cbr/\u003e \u003cimg align=\"right\" width=\"150\" src=\"./docs/images/logo.png\" /\u003e\n\u003c!--\n[![Documentation badge](https://img.shields.io/readthedocs/iotagent-ui.svg)](https://iotagent-ui.rtfd.io/)\n[![CI](https://github.com/Engineering-Research-and-Development/iotagent-ui/workflows/CI/badge.svg)](https://github.com/Engineering-Research-and-Development/iotagent-ui/actions?query=workflow%3ACI)\n[![Coverage Status](https://coveralls.io/repos/github/Engineering-Research-and-Development/iotagent-ui/badge.svg?branch=main)](https://coveralls.io/github/Engineering-Research-and-Development/iotagent-ui?branch=main)\n[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/xxx/badge)](https://www.bestpractices.dev/projects/xxx)\n--\u003e\n\nAn Internet of Things Agent that communicates and monitors any IoT Agent built on top of [IoT Agent Node.js Library](https://github.com/telefonicaid/iotagent-node-lib).\n\nFurther general\ninformation about the FIWARE IoT Agents framework, its architecture and the common interaction model can be found in the\nlibrary's GitHub repository.\n\nThis project is part of [FIWARE](https://www.fiware.org/). For more information check the\n[FIWARE Catalogue entry for the IoT Agents](https://github.com/Fiware/catalogue/tree/main/iot-agents).\n\n| :books: [Documentation](https://iotagent-ui.rtfd.io) | \u003cimg style=\"height:1em\" src=\"https://quay.io/static/img/quay_favicon.png\"/\u003e [quay.io](https://quay.io/repository/fiware/iotagent-ui) | :mortar_board: [Academy](https://fiware-academy.readthedocs.io/en/latest/iot-agents/idas) | :dart: [Roadmap](https://github.com/Engineering-Research-and-Development/iotagent-ui/blob/main/roadmap.md) |\n| ------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |\n\n\n## Contents\n\n-   [Background](#background)\n-   [Install](#getting-started---install)\n    -   [Docker install](#docker---recommended)\n    -   [NPM Install](#npm)\n-   [Usage](#usage)\n-   [API](#api)\n-   [License](#license)\n\n## Background\n\n### Positioning in the overall F4I Reference Architecture\n\nThe growind need of managing serveral IoT Agents installed at industrial plants led to the development of this asset which is a Web User Interface to monitor and control with ease what's happening under the hood. IoT Agent UI is fully compliant with FIWARE iotagent-node-lib thus every agent built on top of this library is supported out-of-the-box. \n\n## Getting Started - Install\n\nCurrently two options are available to install the IoT Agent UI:\n\n### Docker - Recommended\n\nWe suggest using a **Docker-first** approach in order to avoid issues related to your environment configuration.\nMoreover, using this approach you will be provided with all the needed components: Mongo instance\n\nA step-by-step tutorial is available\n[here](https://github.com/Engineering-Research-and-Development/iotagent-ui/blob/main/docs/iot_agent_ui_tutorial.md)\n\n### npm\n\nFollow the two READMEs in the proper project sub-folders:\n[iotagent-ui-spa](https://github.com/Engineering-Research-and-Development/iotagent-ui/blob/main/iotagent-ui-spa/README.md) \n[iotagent-ui-bff](https://github.com/Engineering-Research-and-Development/iotagent-ui/blob/main/iotagent-ui-bff/README.md) \n\n## Usage\n\n\u003cbr/\u003e \u003cimg width=\"600\" src=\"./docs/images/diagram.png\" /\u003e\n\n## API\n\nApiary reference for the Configuration API can be found\n[here](http://docs.telefonicaiotiotagents.apiary.io/#reference/configuration-api) More information about IoT Agents and\ntheir APIs can be found in the IoT Agent Library [documentation](https://iotagent-node-lib.rtfd.io/).\n\n## License\n\nThe IoT Agent UI is licensed under [Affero General Public License (GPL) version 3](./LICENSE).\n\n© 2024 Engineering Ingegneria Informatica S.p.A.\n\nThe following third-party libraries are used under license\n\n1.  [iotagent-node-lib](https://github.com/telefonicaid/iotagent-node-lib) - **AGPL** © 2014-2024 Telefonica\n    Investigación y Desarrollo\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eAre there any legal issues with AGPL 3.0? Is it safe for me to use?\u003c/strong\u003e\u003c/summary\u003e\nThere is absolutely no problem in using a product licensed under AGPL 3.0. Issues with GPL (or AGPL) licenses are mostly\nrelated with the fact that different people assign different interpretations on the meaning of the term “derivate work”\nused in these licenses. Due to this, some people believe that there is a risk in just _using_ software under GPL or AGPL\nlicenses (even without _modifying_ it).\n\nFor the avoidance of doubt, the owners of this software licensed under an AGPL-3.0 license wish to make a clarifying\npublic statement as follows:\n\n\u003e Please note that software derived as a result of modifying the source code of this software in order to fix a bug or\n\u003e incorporate enhancements is considered a derivative work of the product. Software that merely uses or aggregates (i.e.\n\u003e links to) an otherwise unmodified version of existing software is not considered a derivative work, and therefore it\n\u003e does not need to be released as under the same license, or even released as open source.\n\n\u003c/summary\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FEngineering-Research-and-Development%2Fiotagent-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FEngineering-Research-and-Development%2Fiotagent-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FEngineering-Research-and-Development%2Fiotagent-ui/lists"}