-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c6420ae
commit e28bba7
Showing
399 changed files
with
45,881 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
current node | ||
last 2 versions and > 2% | ||
ie > 10 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# Getting started | ||
|
||
This module adds support for managing [FastyBird](https://www.fastybird.com) IoT devices. | ||
|
||
*** | ||
|
||
## Installation | ||
|
||
### Application backend in PHP | ||
|
||
The best way to install **fastybird/devices-module** is using [Composer](https://getcomposer.org/). | ||
|
||
> If you don't have Composer yet, [download it](https://getcomposer.org/download/) 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. | ||
|
||
```sh | ||
composer create-project nette/web-project path/to/install | ||
``` | ||
|
||
Everything required will be then installed in the provided folder. | ||
|
||
```sh | ||
cd path/to/install | ||
``` | ||
|
||
##### Install module | ||
|
||
Module could be added to your project with composer command: | ||
|
||
```sh | ||
composer require fastybird/devices-module | ||
``` | ||
|
||
### Application frontend in JS | ||
|
||
The best way to install **@fastybird/devices-module** is using [Yarn](https://yarnpkg.com/): | ||
|
||
```sh | ||
yarn add @fastybird/devices-module | ||
``` | ||
|
||
or if you prefer npm: | ||
|
||
```sh | ||
npm install @fastybird/devices-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](https://github.com/FastyBird/devices-module/blob/main/config/example.neon) | ||
|
||
## Initialization | ||
|
||
This module is using database, and need some initial data to be inserted into it. | ||
|
||
Execution of command is dependend on you current implementation. This module is dependend | ||
on [contribute/console](https://github.com/contributte/console) extension, so check it out to get know how to configure | ||
your console entrypoint. | ||
|
||
After creating console entrypoint you could call module console command: | ||
|
||
```sh | ||
your-console-entrypoint fb:devices-module:initialize | ||
``` | ||
|
||
This console command is interactive and will ask for all required information. |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
{ | ||
"root": true, | ||
"parser": "@typescript-eslint/parser", | ||
"plugins": [ | ||
"@typescript-eslint" | ||
], | ||
"extends": [ | ||
"eslint:recommended", | ||
"plugin:@typescript-eslint/eslint-recommended", | ||
"plugin:@typescript-eslint/recommended", | ||
"plugin:json/recommended" | ||
], | ||
"rules": { | ||
"lines-between-class-members": [ | ||
"error", | ||
"always", | ||
{ | ||
"exceptAfterSingleLine": true | ||
} | ||
], | ||
"comma-dangle": [ | ||
"error", | ||
{ | ||
"arrays": "always-multiline", | ||
"objects": "always-multiline", | ||
"imports": "always-multiline", | ||
"exports": "always-multiline", | ||
"functions": "always-multiline" | ||
} | ||
], | ||
"space-before-function-paren": [ | ||
"error", | ||
"never" | ||
], | ||
"no-useless-computed-key": "off", | ||
"camelcase": "off", | ||
"@typescript-eslint/ban-ts-comment": "off", | ||
"@typescript-eslint/no-explicit-any": "off" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# Not archived | ||
/.docs export-ignore | ||
/.github export-ignore | ||
/tests export-ignore | ||
.browserslistrc export-ignore | ||
.editorconfig export-ignore | ||
.eslintrc export-ignore | ||
.gitattributes export-ignore | ||
.gitignore export-ignore | ||
.npmignore export-ignore | ||
Makefile export-ignore | ||
phpcs.xml export-ignore | ||
phpstan.neon export-ignore | ||
tslint.json export-ignore |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# These are supported funding model platforms | ||
|
||
github: akadlec |
Oops, something went wrong.