https://github.com/thingsboard/thingsboard-extensions
https://github.com/thingsboard/thingsboard-extensions
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/thingsboard/thingsboard-extensions
- Owner: thingsboard
- Created: 2019-10-01T09:18:26.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-30T11:41:37.000Z (over 1 year ago)
- Last Synced: 2025-03-24T04:43:22.628Z (about 1 year ago)
- Language: TypeScript
- Size: 2.51 MB
- Stars: 22
- Watchers: 9
- Forks: 27
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Extension ThingsBoard Platform
=====================
## ThingsBoard Dependencies
To add some of ThingsBoard dependencies imports to your "extension" Angular component,
please use this import structure:
```
import { } from '/public-api';
```
"TB-module" - any of the following modules:
```
@app/*
@core/*
@shared/*
@modules/*
@home/*
```
"dependency" - name of dependency/type located in "TB-module".
Refer to [modules-map](https://github.com/thingsboard/thingsboard-pe-ui-types/blob/master/src/app/modules/common/modules-map.ts)
to see what you can use.
Example:
```
import { WidgetConfig } from '@shared/public-api';
```
## External Dependencies
In case you want to use your own dependencies package from the npm registry (unless you have specified another one in your package.json), you can easily add them to yarn packet manager running the next command:
```
yarn add
```
Example:
```
yarn add lodash
```
If it's not the npm/yarn registry, and you want to add it in another way, please refer to [yarn docs](https://classic.yarnpkg.com/en/docs/cli/add).
## Run project in development mode
```
cd ${TB_EXTENSION_WORK_DIR}
yarn install
yarn start
```
In widgets library create a new widget and in the resources tab of the widget editor add this file path:
```
http://localhost:5000/static/widgets/thingsboard-extension-widgets.js
```
You must also check "Is module"
## Build project
```
cd ${TB_EXTENSION_WORK_DIR}
yarn build
```
You can find the compiled file at the following path:
```
${TB_EXTENSION_WORK_DIR}/target/generated-resources/thingsboard-extension-widgets.js
```
## Deploy project to customer server
You have two options for deploying extensions:
1) Deploying using our UI. You can find all information about it in our [documentation](https://thingsboard.io/docs/user-guide/contribution/widgets-development/#thingsboard-extensions)
2) Manual deploying. In this case you should use this [branch](https://github.com/thingsboard/thingsboard-extensions/tree/release-3.6-server) of **Thingsboard extensions**