github-desktop/docs/contributing/setup-windows.md

153 lines
5 KiB
Markdown
Raw Normal View History

2018-11-21 14:43:43 +00:00
# Setting Up Development Dependencies on Windows
You will need to install these tools on your machine:
2019-04-18 14:25:32 +00:00
- Node.js
- Yarn
- Python 3
- Visual C++ Build Tools
## Node.js
Let's see if you have the right version of `node` installed. Open a shell and
run this command:
```shellsession
$ node -v
```
2019-04-18 14:25:32 +00:00
If you see an error about being unable to find `node`, that probably means you don't have any Node tools installed.
You can download Node from the [Node.js website](https://nodejs.org/), install the package, and restart your shell.
2022-08-12 15:32:00 +00:00
You can verify that your installed version matches the one currently used by GitHub Desktop by looking at [our .node-version file](https://github.com/desktop/desktop/blob/development/.node-version). Usually the same major version is enough but if you're running into problems building Desktop please try installing that exact version.
**Node.js installation notes:**
- make sure you allow the Node.js installer to add `node` to the `PATH`.
### I need to use different versions of Node.js in different projects!
2018-11-22 15:39:43 +00:00
We currently support `nvm`.
#### Configuring `nvm`
1. Install `nvm` using the instructions [here](https://github.com/coreybutler/nvm-windows).
2. Within the Desktop source directory, install the version of Node.js it requires:
2018-11-22 15:39:43 +00:00
```shellsession
$ nvm install
```
3. Ensure you are running the right version:
```shellsession
$ nvm use
```
4. Verify you have the right version by running `node -v` again:
```shellsession
$ node -v
```
2019-04-18 14:25:32 +00:00
If you see any version number, you're good to go.
## Yarn
Follow [this guide](https://yarnpkg.com/en/docs/install#windows-stable) to install
a system-level `yarn`. GitHub Desktop uses a local version of `yarn`, but it
needs a version on your `PATH` to bootstrap itself.
This is important because `yarn` uses lock files to pin dependencies. If you
find yourself changing packages, this will prevent mismatches in versions
between machines.
If you're not familiar with `yarn`, please read [this document](./working-with-packages.md)
to help familiarize yourself with how to do the common package tasks that are
relevant to Desktop.
## Python
Open a shell and run this command:
```shellsession
$ python --version
```
If you see the output `Python 3.9.x`, you're good to go!
If you see an error about being unable to find `python`, that probably means you
don't have Python installed. You can install Python 3.9 from the
[Python website](https://www.python.org/downloads/windows/).
**Python installation notes:**
- Let Python install into the default suggested path (`c:\Python39`), otherwise
you'll have to configure `node-gyp` manually to look at a different path.
2021-05-15 00:58:13 +00:00
- In case you already have or need to have Python on a different path, set the `PYTHON` environment variable or npm's `python` config key to your Python's executable path:
npm config set python "c:\path\to\python3\python.exe"
- Ensure the **Add python.exe to Path** option is selected.
## Visual C++ Build Tools
To build native Node modules, you will need a recent version of Visual C++ which
can be obtained in several ways:
2020-03-15 01:05:41 +00:00
### Visual Studio 2019
If you have an existing installation of VS2019, run the **Visual Studio
Installer** (Tools > Get Tools and Features...) and check that you have the **Desktop development with C++**
2020-03-15 01:05:41 +00:00
workload included.
<img width="1265" src="https://user-images.githubusercontent.com/7467062/76693187-0fa21d00-662f-11ea-91ba-38326263d4b6.png">
Once you've confirmed that, open a shell and run this command to update the
configuration of NPM:
```shellsession
$ npm config set msvs_version 2019
```
```shellsession
$ npm config set msbuild_path "C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\[VERSION]\\MSBuild\\Current\\Bin\\MSBuild.exe"
```
*Note:* VERSION will be Community, Professional or Enterprise depending on your install.
### Visual Studio 2017
If you have an existing installation of VS2017, run the **Visual Studio
Installer** (Tools > Get Tools and Features...) and check that you have the **Desktop development with C++**
workload included.
<img width="1265" src="https://user-images.githubusercontent.com/359239/48849855-a2091800-ed7d-11e8-950b-93465eba7cd1.png">
Once you've confirmed that, open a shell and run this command to update the
configuration of NPM:
```shellsession
$ npm config set msvs_version 2017
```
### Visual C++ Build Tools
If you do not have an existing Visual Studio installation, there is a
standalone [Visual C++ Build Tools](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools)
installer available.
After installation open a shell and run this command to update the configuration
of NPM:
```shellsession
$ npm config set msvs_version 2019
```
2019-04-18 14:25:32 +00:00
2020-03-15 01:03:37 +00:00
## Troubleshooting
If your local copy gets "stuck" try deleting the folder `C:\Users\[Your_User]\AppData\Roaming\GitHub Desktop-dev`.
2019-04-18 14:25:32 +00:00
## Back to setup
Once you've installed the necessary dependencies, head back to the [setup page](https://github.com/desktop/desktop/blob/development/docs/contributing/setup.md) to finish getting set up.