index.md

Getting started

This module adds support for managing FastyBird IoT accounts, roles and access management.

---

Installation

The best way to install fastybird/accounts-module is using Composer.

If you don't have Composer yet, download it following the instructions.

Create new project

If you don't have a project created yet you could start with Nette base project.

You could create new project with simple composer command.

composer create-project nette/web-project path/to/install

Everything required will be then installed in the provided folder.

cd path/to/install

Install module

Module could be added to your project with composer command:

composer require fastybird/accounts-module

Module user interface

The best way to install @fastybird/accounts-module is using Yarn:

yarn add @fastybird/accounts-module

or if you prefer npm:

npm install @fastybird/accounts-module

Configuration

This module is dependent on other Nette extensions. All this extensions have to enabled and configured in NEON configuration file.

Example configuration could be found here

Initialization

This module is using database, and need some initial data to be inserted into it.

your-console-entrypoint fb:accounts-module:install

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

Running module interface

This module is dependent on fastybird/web-server which is server-less web server for serving API content. This module is registering its routes to this webserver automatically. All what you have to do is start this server with your console entrypoint:

your-console-entrypoint fb:web-server:start

After successful start, server is listening for incoming http api request messages from clients.