https://github.com/kaaproject/kaa-widget-webpack
Kaa IoT Platform Webpack starter kit for plugin widgets
https://github.com/kaaproject/kaa-widget-webpack
Last synced: 3 months ago
JSON representation
Kaa IoT Platform Webpack starter kit for plugin widgets
- Host: GitHub
- URL: https://github.com/kaaproject/kaa-widget-webpack
- Owner: kaaproject
- Created: 2021-04-14T11:34:36.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-30T09:27:13.000Z (about 3 years ago)
- Last Synced: 2025-01-06T17:51:04.412Z (over 1 year ago)
- Language: TypeScript
- Size: 442 KB
- Stars: 1
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Kaa Custom Widget Webpack
This is basic template that help you to build [Custom widget](https://docs.kaaiot.io/KAA/docs/current/Features/Visualization/WD/Custom-widgets/) for
[KaaIoT platform](https://www.kaaproject.org/). This example next features:
* Built with [Webpack](https://webpack.js.org/)
* [React.js](https://reactjs.org/) as the primary UI library
* [@kaaiot/services](https://www.npmjs.com/package/@kaaiot/services) to communicate with KaaIoT rest API
Feel free to change any files and add new packages you want.
## Prerequisites
* Access to KaaIoT UI. You can [create a free cloud account](https://www.kaaproject.org/free-trial) if you don't have one.
* [Node.js](https://nodejs.org/en/) > 18 or [nvm](https://github.com/nvm-sh/nvm)
* npm
## Up and running
Clone this repo:
```sh
git clone https://github.com/kaaproject/kaa-widget-webpack.git
```
If you have nvm:
```sh
nvm install
# Next time for new terminal session
nvm use
```
Install dependencies:
```sh
npm i
```
Run development mode:
```sh
npm start
```
Login into any running KaaIoT [Web Dashboard](https://docs.kaaiot.io/KAA/docs/latest/Features/Visualization/WD/) UI and create a new widget from `Custom widgets` page.
To make a production build:
```sh
npm run build
```
Production build compiles to `dist/index.js`. You can upload this file into running KaaIoT platform using Web Dashboard UI