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-13 04:16:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Docker requirements (#467)

Browse Source
This commit is contained in:
Tom Brien 2020-04-22 01:02:21 +01:00 committed by GitHub
parent 607824c2c1
commit ef82fe7149
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/development_environment.md
View File

@ -4,14 +4,16 @@ title: "Set up Development Environment"
You'll need to set up a development environment if you want to develop a new feature or component for Home Assistant. Read on to learn how to set up.
# Developing with Visual Studio Code + devcontainer
## Developing with Visual Studio Code + devcontainer
The easiest way to get started with development is to use Visual Studio Code with devcontainers. This approach will create a preconfigured development environment with all the tools you need. This approach is enabled for all Home Assistant repositories.
**Prerequisites**
- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- [Docker](https://docs.docker.com/install/) (Windows only: requires Windows Pro)
- Docker
- For Linux, macOS, or Windows 10 Pro/Enterprise/Education use the [current release version of Docker](https://docs.docker.com/install/)
- Windows 10 Home requires [WSL 2](https://docs.microsoft.com/windows/wsl/wsl2-install) and the current Edge version of Docker Desktop (see instructions [here](https://docs.docker.com/docker-for-windows/wsl-tech-preview/)). This can also be used for Windows Pro/Enterprise/Education.
- [Visual Studio code](https://code.visualstudio.com/)
- [Remote - Containers (VSC Extension)][extension-link]
@ -29,13 +31,13 @@ When you open this repository with Visual Studio code you are asked to "Reopen i
_If you don't see this notification, open the command palette and select `Remote-Containers: Reopen Folder in Container`._
## Tasks
### Tasks
The devcontainter comes with some useful tasks to help you with development, you can start these tasks by opening the command palette and select `Tasks: Run Task` then select the task you want to run.
When a task is currently running (like `Preview` for the docs), it can be restarted by opening the command palette and selecting `Tasks: Restart Running Task`, then select the task you want to restart.
# Preparing your environment
## Preparing Your environment
It is also possible to set up a more traditional development environment. See the section for your operating system.
@ -119,7 +121,7 @@ $ git remote add upstream https://github.com/home-assistant/core.git
Note that `core.git` should be replaced by the name of your fork (default being `core.git`). If unsure check your GitHub repository.
## Setting up virtual environment
## Setting Up Virtual Environment
To isolate your environment from the rest of the system, set up a [`venv`](https://docs.python.org/3/library/venv.html). Within the `core` directory, create and activate your virtual environment.