fastybird/ui-module

FastyBird IoT module for managing visual components

dev-main / 1.0.x-dev 2024-09-29 21:21 UTC

Requires

• php: >=8.2.0
• ext-bcmath: *
• ext-pcntl: *
• contributte/console: ^0.9
• contributte/monolog: ^0.5
• contributte/translation: ^2.0
• cweagans/composer-patches: ^1.7
• fastybird/application-library: dev-main
• fastybird/exchange-library: dev-main
• fastybird/json-api: ^0.19
• fastybird/metadata-library: dev-main
• fastybird/simple-auth: ^0.14
• fastybird/tools-library: dev-main
• ipub/slim-router: ^0.2
• nettrine/dbal: ^0.8
• nettrine/orm: ^0.8
• psr/event-dispatcher: ^1.0
• react/async: ^4.0
• react/event-loop: ^1.3
• react/promise: ^3
• softcreatr/jsonpath: ^0.8
• symfony/console: ^6.0
• symfony/event-dispatcher: ^7.0
• symplify/vendor-patches: ^11.2

Requires (Dev)

• brianium/paratest: ^7.3
• dg/bypass-finals: ^1.4
• infection/infection: ^0.27
• ipub/websockets: ^1.7
• ipub/websockets-wamp: ^1.4
• orisai/coding-standard: ^3.2
• pds/skeleton: ^1.0
• php-parallel-lint/php-parallel-lint: ^1.3
• phpstan/extension-installer: ^1.1
• phpstan/phpstan: ^1.10
• phpstan/phpstan-deprecation-rules: ^1.0
• phpstan/phpstan-doctrine: ^1.3
• phpstan/phpstan-nette: ^1.1
• phpstan/phpstan-phpunit: ^1.1
• phpstan/phpstan-strict-rules: ^1.4
• phpunit/phpunit: ^10.0
• react/http: ^1.7
• staabm/annotate-pull-request-from-checkstyle: ^1.8
• tracy/tracy: ^2.9

Apache-2.0

• FastyBird s.r.o.
• Adam Kadlec

• php
• ui
• api
• nette
• controls
• fb
• user interface
• iot
• typescript
• vuejs
• vue
• fastybird
• vue3
• pinia

README

FastyBird IoT UI module

What is FastyBird IoT UI module?

UI module is a FastyBird IoT extension for managing visual components and widgets used for IoT controls and user interfaces.

Features:

• Dashboards with pages management
• Groups management
• Widgets management
• {JSON:API} schemas for full api access
• User access check & validation
• Multilingual
• User interface integration via Vue 3 components
• Integrated connector worker for PHP based connectors

FastyBird IoT UI module is an Apache2 licensed distributed extension, developed in PHP on top of the Nette framework and Symfony framework and in Typescript on top of the Vue framework.

Requirements

PHP part of FastyBird UI module is tested against PHP 8.2 and require installed Process Control PHP extensions.

JavaScript part of FastyBird UI module is tested against ECMAScript 6

Installation

This extension is part of the FastyBird IoT ecosystem and is installed by default. In case you want to create you own distribution of FastyBird IoT ecosystem you could install this extension with Composer:

composer require fastybird/ui-module

And for user interface is the best way to install @fastybird/ui-module with Yarn:

yarn add @fastybird/ui-module

or if you prefer npm:

npm install @fastybird/ui-module

Documentation

📖 Learn how to configure and use UI module and manage your dashboards & widgets in documentation.

FastyBird

FastyBird is an Open Source IOT solution built from decoupled components with powerful API and the highest quality code. Read more on fastybird.com.com.

Documentation

📖 Documentation is available on docs.fastybird.com.

Contributing

The sources of this package are contained in the FastyBird monorepo. We welcome contributions for this package on FastyBird/fastybird.

Feedback

Use the issue tracker for bugs reporting or send an mail to us or you could reach us on X newtwork for any idea that can improve the project.

Thank you for testing, reporting and contributing.

Changelog

For release info check release page.

Maintainers

Homepage https://www.fastybird.com and repository https://github.com/fastybird/ui-module.