fastybird/web-ui-app repository overview
FastyBird IoT Web UI app
What is FastyBird IoT Web UI app?
Web UI app is a user interface for visual controlling devices & services controlled by FastyBird ecosystem.
FastyBird IoT Web UI app is an Apache2 licensed distributed web app, developed in JS with NuxtJS framework.
Requirements
FastyBird Web UI app is tested against ECMAScript 6
Getting started
NOTE: If you don't want to install it manually, try docker image
The best way to install @fastybird/web-ui-app is using Yarn. If you don't have Yarn yet, download it following the instructions. Then use command:
$ git clone [email protected]:FastyBird/web-ui-app.git path/to/install
$ cd path/to/install
$ yarn install
Everything required will be then installed in the provided folder path/to/install
Development mode
$ yarn dev
This command will start web app in development mode available as http://localhost:3000
Build mode & production mode
$ yarn build
$ yarn start
This command build app from source files and start node server which is listening for incoming http requests.
Install with docker
Docker image: fastybird/web-ui-app
Use docker hub image
$ docker run -d -it --name web-ui fastybird/web-ui-app:latest
Generate local image
$ docker build --tag=web-ui-app .
$ docker run -d -it --name web-ui-app web-ui-app
Configuration
This application is preconfigured for default connections, but your infrastructure could be different.
Configuration could be made via environment variables:
| Environment Variable | Description |
|---|---|
NUXT_ENV_API_KEY= | API key allowing access to FastyBird manager service |
NUXT_ENV_API_TARGET=127.0.0.1/api | FastyBird manager API address |
NUXT_ENV_WS_KEY= | WS key allowing access to websockets service |
NUXT_ENV_WS_TARGET=127.0.0.1:9000 | WS server address |
NUXT_ENV_SENTRY_DNS= | Sentry bugtracking DSN |
NUXT_ENV_SENTRY_ENV= | Sentry env name, if empty, node env is used |
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
Homepage http://www.fastybird.com and repository http://github.com/fastybird/web-ui-app.
Tag summary
Content type
Image
Digest
Size
506.7 MB
Last updated
about 5 years ago
docker pull fastybird/web-ui-app