fastybird/miniserver

Repository for FastyBird packages development

dev-main 2024-08-07 12:24 UTC

Requires

• php: >=8.2.0
• contributte/event-dispatcher: ^0.9
• contributte/translation: ^2.0
• fastybird/fastybird: dev-main
• nettrine/fixtures: ^0.6.3
• nettrine/migrations: ^0.8.0
• vlucas/phpdotenv: ^5.4

Requires (Dev)

• brianium/paratest: ^6.6
• dg/bypass-finals: ^1.4
• infection/infection: ^0.26
• 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.9
• 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: ^9.5
• 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

README

FastyBird MiniServer Edition

This is FastyBird MiniServer Edition repository for starting new projects.

What is FastyBird IoT MiniServer?

MiniServer is standalone application based on FastyBird IoT software. The highest quality of code and strong testing culture, make it best solution for build smart controller application.

FastyBird IoT MiniServer is an Apache2 licensed distributed application, developed on top of the Nette framework and Symfony framework.

Features:

• Devices & connectors management
• User & access control management
• {JSON:API} strong api for application management
• Responsive user interface
• Third party devices integration like Shelly, Tuya and other
• Full HomeKit with HAP protocol integration

Requirements

FastyBird MiniServer is tested against PHP 8.1, Redis 6.2 in-memory data store, MySQL relational database management system, ReactPHP http 0.8 event-driven, streaming plaintext HTTP server and Nette framework 3.0 PHP framework for real programmers.

Getting started

NOTE: If you don't want to install it manually, try docker image

Traditional installation

The best way to install fastybird/miniserver is using Composer. If you don't have Composer yet, download it following the instructions. Then use command:

composer create-project --no-dev fastybird/miniserver path/to/install

cd path/to/install

Everything required will be then installed in the provided folder path/to/install

Running app

You have two options how to run this app

Running an app via ReactPHP http server

All what you need is just run one console command:

vendor/bin/fb-console fb:web-server:start

This command will start build in web server which is listening for incoming http api request messages from clients.

Running an app via Apache or Nginx

You have to configure you web server running on Apache or Nginx to server content from public folder.

In this folder is main entry point for accessing application api.

Install with docker

Docker image: fastybird/miniserver

Use docker hub image

docker run -d -it --name devices fastybird/miniserver:latest

Generate local image

docker build --tag=miniserver .

docker run -d -it --name miniserver miniserver

Initialization

This application is using database, and need some initial data to be inserted into it. This could be done via shell command:

vendor/bin/fb-console fb:initialize

This console command is interactive and will ask for all required information.

After this steps, application could be started with server command

Feedback

Use the issue tracker for bugs or mail or Tweet us for any idea that can improve the project.

Thank you for testing, reporting and contributing.

Changelog

For release info check release page

Maintainers

Adam Kadlec

Homepage https://www.fastybird.com and repository https://github.com/fastybird/miniserver.