jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-21 08:16:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve frontend development setup instructions (#171)

Browse Source 
* Improve frontend development setup instructions

- Currently you recommend cloning the `home-assistant-polymer` repository directly. I assume you should instruct people to fork it, like you do in the [development environment documentation](https://developers.home-assistant.io/docs/en/development_environment.html)
- I had some trouble setting `development_repo` in macOS, I believe a trailing slash was necessary in the path. Have updated to a realistic macOS example path

* Link to Getting Started instead of macOS install instructions

* Revert comment change

* Change link to Installation Guide

* Adjust link to point to dev setup docs
This commit is contained in:
Alec Rust 2019-01-29 18:07:57 +00:00 committed by Paulus Schoutsen
parent a23e34bc2f
commit 98a86bb95f
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/frontend_development.md
View File

@ -13,15 +13,18 @@ The Home Assistant frontend is built using web components and powered by the [Po
### Getting the code
First step is to git clone the [home-assistant-polymer repository][hass-polymer]. You can place the repository anywhere on your system.
First step is to fork the [home-assistant-polymer repository][hass-polymer] and add the upstream remote. You can place the forked repository anywhere on your system.
```bash
$ git clone https://github.com/home-assistant/home-assistant-polymer.git
$ git clone https://github.com/YOUR_GIT_USERNAME/home-assistant-polymer.git
$ cd home-assistant-polymer
$ git remote add upstream https://github.com/home-assistant-polymer/home-assistant-polymer.git
```
### Configuring Home Assistant
You will need to have an instance of Home Assistant set up. See our guide on [setting up a development environment](https://developers.home-assistant.io/docs/en/development_environment.html).
Next 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 home-assistant-polymer repository that you cloned in the last step:
```yaml