You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You will need to have an instance of Home Assistant set up. See our guide on [setting up a development environment](/development_environment.mdx).
27
27
28
-
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 frontend repository that you cloned in the last step:
28
+
#### Developing with Visual Studio Code + dev container
29
29
30
-
```yaml
31
-
frontend:
32
-
# Example absolute path: /home/paulus/dev/hass/frontend
33
-
development_repo: /path/to/hass/frontend/
34
-
```
35
-
36
-
If you are using Visual Studio Code with devcontainers for Home Assistant, you need to mount the `frontend` directory into the container. Add the following section to `.devcontainer/devcontainer.json`:
30
+
If you are using Visual Studio Code with dev containers for Home Assistant Core, you need to mount the frontend repository into the dev container. Add the following section to `.devcontainer/devcontainer.json` in the Home Assistant Core repository:
The Home Assistant's devcontainer needs to get rebuilt via the `Dev Containers: Rebuild Container` with: Shift+Command+P(Mac) / Ctrl+Shift+P (Windows/Linux). The `configuration.yaml` should point to the path inside the container:
38
+
Rebuild the dev container by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux) to open the Command Palette, then selecting the **Dev Containers: Rebuild Container** command.
39
+
40
+
Edit `config/configuration.yaml` at the root of the Home Assistant Core repository to add this entry:
45
41
46
42
```yaml
47
43
frontend:
48
-
development_repo: /workspaces/frontend/
44
+
development_repo: /workspaces/frontend
49
45
```
50
46
47
+
:::note
48
+
This is the mounted path inside the dev container, see the `target` parameter above. If the `source` path is incorrect, the web frontend won't work.
49
+
:::
50
+
51
+
Run Home Assistant Core from VS Code:
52
+
1. Open the Command Palette:
53
+
- Mac: `Shift+Command+P`
54
+
- Windows/Linux: `Ctrl+Shift+P`
55
+
2. Select **Tasks: Run Task**
56
+
3. Select **Run Home Assistant Core**
57
+
51
58
:::caution
52
-
The change to `.devcontainer/devcontainer.json` should be excluded from any PR as it contains your local path to the `frontend` repository. Since the the settings in `.devcontainer/devcontainer.json` are only processed during the container rebuild, you can safely roll back the change after the rebuild has completed.
59
+
The change to `.devcontainer/devcontainer.json` should be excluded from any PR as it contains your local path to the `frontend` repository. Since the settings in `.devcontainer/devcontainer.json` are only processed during the container rebuild, you can safely roll back the change after the rebuild has completed.
60
+
:::
61
+
62
+
#### Developing with a manual environment
63
+
64
+
If you set up the development environment for Home Assistant Core manually, fill in the frontend repository path in `configuration.yaml`:
65
+
66
+
```yaml
67
+
frontend:
68
+
# Example path: /home/paulus/dev/hass/frontend
69
+
development_repo: /path/to/hass/frontend
70
+
```
71
+
72
+
:::tip
73
+
The `configuration.yaml` file can be found in the `config` directory at the root of the Home Assistant Core repository. If the path is incorrect or otherwise inaccessible, the web frontend won't work.
53
74
:::
54
75
55
-
### Installing Node.js
76
+
### Installing Node.js (manual environment only)
56
77
57
78
Node.js is required to build the frontend. The preferred method of installing node.js is with [nvm](https://github.com/nvm-sh/nvm). Install nvm using the instructions in the [README](https://github.com/nvm-sh/nvm#install--update-script), and install the correct node.js by running the following command:
58
79
@@ -62,36 +83,48 @@ nvm install
62
83
63
84
[Yarn](https://yarnpkg.com/en/) is used as the package manager for node modules. [Install yarn using the instructions here.](https://yarnpkg.com/getting-started/install)
64
85
65
-
Next, development dependencies need to be installed to bootstrap the frontend development environment. First activate the right Node version and then download all the dependencies:
86
+
### Install development dependencies and fetch latest translations
87
+
88
+
Bootstrap the frontend development environment by installing development dependencies and downloading the latest translations.
66
89
67
90
```shell
68
91
nvm use
69
92
script/bootstrap
70
93
script/setup_translations
71
94
```
72
95
96
+
:::note
97
+
This needs to be done manually, even if you are using dev containers. Also, you will be asked to enter a code and authorize the script to fetch the latest translations.
98
+
:::
99
+
73
100
## Development
74
101
75
-
During development, you will need to run the development script to maintain a development build of the frontend that auto updates when you change any of the source files. To run this server, run:
102
+
### Run development server
103
+
104
+
Run this script to build the frontend and run a development server:
76
105
77
106
```shell
78
107
nvm use
79
108
script/develop
80
109
```
81
110
82
-
Make sure you have cache disabled and correct settings to avoid stale content:
111
+
When the script has completed building the frontend, and Home Assistant Core has been set up correctly, the frontend will be accessible at `http://localhost:8123`. The server will automatically rebuild the frontend when you make changes to the source files.
112
+
113
+
### Browser settings
114
+
115
+
Open Google Chrome's Developer tools, and make sure you have cache disabled and correct settings to avoid stale content:
83
116
84
117
:::info
85
118
Instructions are for Google Chrome
86
119
:::
87
120
88
-
1. Disable cache by ticking the box in `Network` > `Disable cache`
121
+
1. Disable cache by ticking the box in **Network** > **Disable cache**
0 commit comments