Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fastybird/ui-module

:art: [READ-ONLY] FastyBird IoT UI module for visual components & basic control logic
https://github.com/fastybird/ui-module

api component dashboards fastybird iot ui user-interface widget widgets

Last synced: about 1 month ago
JSON representation

:art: [READ-ONLY] FastyBird IoT UI module for visual components & basic control logic

Host: GitHub
URL: https://github.com/fastybird/ui-module
Owner: FastyBird
License: apache-2.0
Created: 2020-12-02T17:29:48.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2024-09-29T21:21:54.000Z (3 months ago)
Last Synced: 2024-11-13T14:30:01.252Z (about 2 months ago)
Topics: api, component, dashboards, fastybird, iot, ui, user-interface, widget, widgets
Language: PHP
Homepage:
Size: 491 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG-1.0.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

README

        


	



# FastyBird IoT UI module

[![Build Status](https://flat.badgen.net/github/checks/FastyBird/ui-module/main?cache=300&style=flat-square)](https://github.com/FastyBird/ui-module/actions)

[![Licence](https://flat.badgen.net/github/license/FastyBird/ui-module?cache=300&style=flat-square)](https://github.com/FastyBird/ui-module/blob/main/LICENSE.md)

[![Code coverage](https://flat.badgen.net/coveralls/c/github/FastyBird/ui-module?cache=300&style=flat-square)](https://coveralls.io/r/FastyBird/ui-module)

[![Mutation testing](https://img.shields.io/endpoint?style=flat-square&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2FFastyBird%2Fui-module%2Fmain)](https://dashboard.stryker-mutator.io/reports/github.com/FastyBird/ui-module/main)

![PHP](https://flat.badgen.net/packagist/php/FastyBird/ui-module?cache=300&style=flat-square)

[![Latest stable](https://flat.badgen.net/packagist/v/FastyBird/ui-module/latest?cache=300&style=flat-square)](https://packagist.org/packages/FastyBird/ui-module)

[![Downloads total](https://flat.badgen.net/packagist/dt/FastyBird/ui-module?cache=300&style=flat-square)](https://packagist.org/packages/FastyBird/ui-module)

[![PHPStan](https://flat.badgen.net/static/PHPStan/enabled/green?cache=300&style=flat-square)](https://github.com/phpstan/phpstan)

![JS](https://flat.badgen.net/static/js/es6/blue?cache=300&style=flat-square)

[![JS latest stable](https://flat.badgen.net/npm/v/@fastybird/ui-module?cache=300&style=flat-square)](https://www.npmjs.com/package/@fastybird/ui-module)

[![JS downloads total](https://flat.badgen.net/npm/dt/@fastybird/ui-module?cache=300&style=flat-square)](https://www.npmjs.com/package/@fastybird/ui-module)

![Types](https://flat.badgen.net/npm/types/@fastybird/ui-module?cache=300&style=flat-square)

***

## What is FastyBird IoT UI module?

UI module is a [FastyBird](https://www.fastybird.com) [IoT](https://en.wikipedia.org/wiki/Internet_of_things)

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}](https://jsonapi.org/) schemas for full api access

- User access [check & validation](https://github.com/FastyBird/simple-auth)

- Multilingual

- User interface integration via [Vue 3](https://vuejs.org) components

- Integrated connector worker for PHP based connectors

[FastyBird](https://www.fastybird.com) [IoT](https://en.wikipedia.org/wiki/Internet_of_things) UI module is

an [Apache2 licensed](http://www.apache.org/licenses/LICENSE-2.0) distributed extension, developed

in [PHP](https://www.php.net) on top of the [Nette framework](https://nette.org) and [Symfony framework](https://symfony.com) and in [Typescript](https://www.typescriptlang.org) on top of the [Vue framework](https://vuejs.org).

## Requirements

PHP part of [FastyBird](https://www.fastybird.com) UI module is tested against PHP 8.2 and require installed [Process Control](https://www.php.net/manual/en/book.pcntl.php) PHP extensions.

JavaScript part of [FastyBird](https://www.fastybird.com) UI module is tested

against [ECMAScript 6](https://www.w3schools.com/JS/js_es6.asp)

## Installation

This extension is part of the [FastyBird](https://www.fastybird.com) [IoT](https://en.wikipedia.org/wiki/Internet_of_things) ecosystem and is installed by default.

In case you want to create you own distribution of [FastyBird](https://www.fastybird.com) [IoT](https://en.wikipedia.org/wiki/Internet_of_things) ecosystem you could install this extension with  [Composer](http://getcomposer.org/):

```sh

composer require fastybird/ui-module

```

And for user interface is the best way to install **@fastybird/ui-module** with [Yarn](https://yarnpkg.com/):

```sh

yarn add @fastybird/ui-module

```

or if you prefer npm:

```sh

npm install @fastybird/ui-module

```

## Documentation

:book: Learn how to configure and use UI module and manage your dashboards & widgets

in [documentation](https://github.com/FastyBird/ui-module/wiki).

# 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](https://www.fastybird.com).

## Documentation

:book: Documentation is available on [docs.fastybird.com](https://docs.fastybird.com).

## Contributing

The sources of this package are contained in the [FastyBird monorepo](https://github.com/FastyBird/fastybird). We welcome

contributions for this package on [FastyBird/fastybird](https://github.com/FastyBird/).

## Feedback

Use the [issue tracker](https://github.com/FastyBird/fastybird/issues) for bugs reporting or send an [mail](mailto:[email protected])

to us or you could reach us on [X newtwork](https://x.com/fastybird) for any idea that can improve the project.

Thank you for testing, reporting and contributing.

## Changelog

For release info check [release page](https://github.com/FastyBird/fastybird/releases).

## Maintainers

	

		

			

				

					

				

				


				Adam Kadlec

			

		

	

***

Homepage [https://www.fastybird.com](https://www.fastybird.com) and

repository [https://github.com/fastybird/ui-module](https://github.com/fastybird/ui-module).