openhab-core/bundles/org.openhab.ui.homebuilder/README.md
Kuba Wolanin 3d811ecede HomeBuilder - Initial contribution (#172)
openHAB Home Builder - home structure generator

Also-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
Also-by: Demyan Rogozhin <dmitriy.rogozhin@gmail.com> (github: demyanrogozhin)
Signed-off-by: Kuba Wolanin <hi@kubawolanin.com> (github: kubawolanin)
2017-12-03 00:13:10 +01:00

33 lines
1.1 KiB
Markdown

# Home Builder
> Boilerplate for the [Items](http://docs.openhab.org/configuration/items.html), [sitemap](http://docs.openhab.org/configuration/sitemaps.html) files and [HABPanel](http://docs.openhab.org/addons/uis/habpanel/readme.html) dashboard.
## Usage
See [USAGE.md](USAGE.md) file for reference.
## Development
HomeBuilder UI is an app based on [Vue.js](http://vuejs.org) framework.
In order to setup the development environment simply run:
``` bash
cd web
npm install
npm run dev
```
The first command will install all necessary dependencies (including Webpack build system).
`npm run dev`, however, will serve the build with hot reload at `http://localhost:8080`.
It's recommended to debug the app on Chrome or Firefox with [Vue.js devtools](https://chrome.google.com/webstore/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd) extension.
When you're done with your changes and would like to test HomeBuilder on a real environment, run the following command:
``` bash
# build for production with minification
npm run build
```
It will build the app inside `/web/dist/` folder with source map included.