github-desktop/docs/contributing/mac-deps-setup.md

51 lines
1.8 KiB
Markdown
Raw Normal View History

2018-09-13 16:16:49 +00:00
# Setting Up Development Dependencies on macOS
2018-09-03 18:28:44 +00:00
2018-09-13 14:42:45 +00:00
You will need to install these tools on your machine:
- Node.js v8.11.4
- Python 2.7
- Xcode and Xcode Command Line Tools (Xcode -> Preferences -> Downloads)
2018-09-10 20:22:57 +00:00
## Node.js
2018-09-03 18:28:44 +00:00
2018-09-14 20:22:58 +00:00
There are two approaches to installing Node.js, **manual** and **managed**. If you're not sure which route to go, we recommend the managed route, but do whatever makes the most sense for your development process!
2018-09-03 18:28:44 +00:00
2018-09-10 20:22:57 +00:00
### Managed
2018-09-03 18:28:44 +00:00
We recommend using [nvm](https://github.com/creationix/nvm) to manage your Node.js version. This makes it easier to know you are running the correct version of node for this project without affecting setup for other projects on your machine.
2018-09-03 18:28:44 +00:00
- Install nvm from https://github.com/creationix/nvm#install-script
- At the top level of this repo:
- Install the version of Node.js for GitHub Desktop with `nvm install`
- Use that version with `nvm use`
- You're good to go!
2018-09-03 18:28:44 +00:00
2018-09-14 20:22:58 +00:00
Suitable alternatives include (but aren't limited to) [n](https://github.com/tj/n) and [asdf-nodejs](https://github.com/asdf-vm/asdf-nodejs).
2018-09-03 18:28:44 +00:00
### Manual
- Install manually from https://nodejs.org/en/download/
2018-09-04 03:50:52 +00:00
- You're good to go!
2018-09-04 00:53:54 +00:00
## Python
2018-09-10 20:22:57 +00:00
macOS comes with Python pre-installed, and it happens to be the right version, so you're probably fine! But if you use other versions of Python, here's how to get started.
2018-09-04 00:53:54 +00:00
2018-09-10 20:22:57 +00:00
### Managed
2018-09-04 00:53:54 +00:00
2018-09-14 20:22:58 +00:00
For this, we recommend [pyenv](https://github.com/pyenv/pyenv). (It's the only game in town.)
- Install pyenv according to https://github.com/pyenv/pyenv-installer#github-way-recommended
- At the top level of this repo:
- Install the version of Python for GitHub Desktop with `pyenv install`
- You're good to go!
2018-09-04 00:53:54 +00:00
### Manual
2018-09-04 03:50:52 +00:00
- Install manually from https://www.python.org/downloads/
- You're good to go!
2018-09-10 20:22:57 +00:00
## Xcode Command Line Tools
2018-09-04 03:50:52 +00:00
- Just run `xcode-select --install`