Home Assistant will by default serve the compiled version of the frontend. As everything is compiled into the file frontend.html you do not want to work with the compiled version but with the separate files during development. To enable development mode for Home Assistant, update your configuration.yaml to have these lines:
http:
- development: 1
+
+All commands below need to be run from inside the home-assistant-polymer repository.
+
+Home Assistant will by default serve the compiled version of the frontend from the hass_frontend Python package. For development you want to work with the unbundled source files which are in the home-assistant-polymer repository.
+First step is to configure Home Assistant to use the development mode for the frontend. Do this by updating the frontend config in your configuration.yaml and set the path to the polymer repo:
+frontend:
+ development_repo: ../home-assistant-polymer
-Node.js is required to setup the frontend development environment. The preferred method of installing node.js is nvm. Install nvm using the instructions in the README, and install the correct node.js by running the following command from the home-assistant directory:
-$ git submodule update --init
-$ nvm install $(<homeassistant/components/frontend/www_static/home-assistant-polymer/.nvmrc)
+Next step is to git clone the home-assistant-polymer repository. You can place the repository anywhere on your system but to keep these instructions simple we’re cloning the home-assistant-polymer repository as a sibling to the Home Assistant repo.
+$ git clone https://github.com/home-assistant/home-assistant-polymer.git
+$ cd home-assistant-polymer
+
+
+After cloning, your folder structure should look like this:
+/home-assistant
+/home-assistant-polymer
+
+
+Node.js is required to build the frontend. The preferred method of installing node.js is with nvm. Install nvm using the instructions in the README, and install the correct node.js by running the following command:
+$ nvm install
Yarn is used as the package manager for node modules. Install yarn using the instructions here.
-Next, development dependencies need to be installed to bootstrap the frontend development environment by running from the home-assistant directory:
-$ script/bootstrap_frontend
+Next, development dependencies need to be installed to bootstrap the frontend development environment. First activate the right Node version and then download all the needed modules and do a first build:
+$ nvm use
+$ script/bootstrap
-This script will use yarn and bower to install all the necessary dependencies necessary for development in
-home-assistant/homeassistant/components/frontend/www_static/home-assistant-polymer.
-If you’re planning on issuing a PR back to the Home Assistant codebase you need to fork the polymer project and add your fork as a remote.
-$ cd homeassistant/components/frontend/www_static/home-assistant-polymer
-$ git remote add <remote name> <github URL to your fork>
+This script will use yarn and bower to install all the necessary dependencies necessary for development and do an initial build.
+ Creating pull requests
+If you’re planning on issuing a PR back to the Home Assistant codebase you need to fork the polymer project and add your fork as a remote to the Home Assistant Polymer repo.
+$ git remote add <remote name> <github URL to your fork>
When you’ve made your changes and are ready to push them change to the working directory for the polymer project and then push your changes
-$ cd homeassistant/components/frontend/www_static/home-assistant-polymer
+$ git add -A
+$ git commit -m "Added new feature X"
$ git push -u <remote name> HEAD
Development
-While you are developing, you need to have Rollup running to have changes you make to the JavaScript app-core made available.
-$ cd homeassistant/components/frontend/www_static/home-assistant-polymer
-$ yarn run dev
+While you are developing, you need to have gulp running to watch the source files for changes and build when necessary.
+$ yarn run dev-watch
The source code for the frontend can be found in two different directories:
- - UI:
homeassistant/components/frontend/www_static/home-assistant-polymer/src/
- - Panels:
homeassistant/components/frontend/www_static/home-assistant-polymer/panels/
+ - UI:
/home-assistant-polymer/src/
+ - Panels:
/home-assistant-polymer/panels/
Building the Polymer frontend
-Building a new version of the frontend is as simple as running script/build_frontend. This fires off the following commands:
-
- - home-assistant-polymer: Install NPM dependencies.
- - home-assistant-polymer: start frontend build.
-
- - Compile all used JavaScript.
- - Install Bower dependencies.
- - Vulcanize and minify the core and panel sources to build dir.
-
-
- - Copy the webcomponents polyfill
webcomponents-lite.min.js from home-assistant-polymer to components/frontend/www_static/webcomponents-lite.min.js.
- - Copy the final frontend build
frontend.html and panel sources from home-assistant-polymer to components/frontend/www_static/frontend/.
- - Generate MD5 hashes of core and panel sources.
- - Create gzip versions of all the sources.
-
+Building a new version of the frontend is as simple as running script/build_frontend.