Laptop

Laptop is a script to set up an macOS laptop for web and mobile development.

It can be run multiple times on the same machine safely. It installs, upgrades, or skips packages based on what is already installed on the machine.

Requirements

We support:

• macOS Mavericks (10.9)
• macOS Yosemite (10.10)
• macOS El Capitan (10.11)
• macOS Sierra (10.12)
• macOS High Sierra (10.13)

Older versions may work but aren't regularly tested. Bug reports for older versions are welcome.

Install

Download the script:

curl --remote-name https://raw.githubusercontent.com/goodtouch/laptop/master/mac

Review the script (avoid running scripts you haven't read!):

less mac

Execute the downloaded script:

sh mac 2>&1 | tee ~/laptop.log

Optionally, review the log:

less ~/laptop.log

Optionally, install thoughtbot/dotfiles.

Debugging

Your last Laptop run will be saved to ~/laptop.log. Read through it to see if you can debug the issue yourself.

What it sets up

macOS tools:

• Homebrew for managing operating system libraries.

Unix tools:

• Git for version control
• iTerm2 replacement for Terminal
• OpenSSL for Transport Layer Security (TLS)
• The Silver Searcher for finding things in files
• Tmux for saving project state and switching between projects
• reattach-to-user-namespace Reattach process (e.g., tmux) to background (Fix Copy & Paste in Tmux)
• Universal Ctags for indexing files for vim tab completion
• Watchman for watching for filesystem events
• Zsh as your shell
• z to navigate to your most used directories

Image tools:

• ImageMagick for cropping and resizing images

Testing tools:

• ChromeDriver for headless JavaScript testing via Capybara and Selenium Webdriver

Programming languages, package managers, and configuration:

• ASDF for managing programming language versions
• Bundler for managing Ruby libraries
• Java: for writing Android applications
• Node.js and NPM, for running apps and installing JavaScript packages
• Ruby stable for writing general-purpose code
• Yarn for managing JavaScript packages

Databases:

• Postgres for storing relational data
• MySQL for storing relational data
• SQLite for storing relational data
• Redis for storing key-value data

Editors:

• Visual Studio Code: Microsoft hackable text editor
• Vim: Vi "workalike" with many additional features

Source code management:

• GitX-dev: fork of GitX with some nice improvements

Virtualization & Containerization:

• virtualbox
• vagrant
• docker

It should take less than 15 minutes to install (depends on your machine).

Customize in ~/.laptop.local

Your ~/.laptop.local is run at the end of the Laptop script. Put your customizations there. For example:

#!/bin/sh

brew bundle --file=- <<EOF
brew "Caskroom/cask/dockertoolbox"
brew "go"
brew "ngrok"
brew "watch"
EOF

default_docker_machine() {
  docker-machine ls | grep -Fq "default"
}

if ! default_docker_machine; then
  docker-machine create --driver virtualbox default
fi

default_docker_machine_running() {
  default_docker_machine | grep -Fq "Running"
}

if ! default_docker_machine_running; then
  docker-machine start default
fi

fancy_echo "Cleaning up old Homebrew formulae ..."
brew cleanup
brew cask cleanup

if [ -r "$HOME/.rcrc" ]; then
  fancy_echo "Updating dotfiles ..."
  rcup
fi

Write your customizations such that they can be run safely more than once. See the mac script for examples.

Laptop functions such as fancy_echo and gem_install_or_update can be used in your ~/.laptop.local.

See the wiki for more customization examples.

.laptop.local.example

In the .laptop.local.example file, you'll find how to customize your .laptop.local file to install:

Programming languages, package managers, and configuration:

• Elixir and Erlang stable
• Go stable

Mobile development tools:

• Android Platform Tools: Tools for the Android SDK
• Android Studio: Official IDE for Android

Graphics & Design:

• sketch
• sketch-beta

Media

• spotify

Team & Chat:

• Discord
• Mattermost
• Skype
• Slack

Sync & Cloud:

• Dropbox
• Google-drive
• Resilio-sync
• Sparkleshare

Firewall:

• little-snitch

Fonts:

• fontforge
• font-source-code-pro
• font-source-code-pro-for-powerline

Contributing

Edit the mac file. Document in the README.md file. Follow shell style guidelines by using ShellCheck and Syntastic.

brew install shellcheck

Thank you, contributors!

By participating in this project, you agree to abide by the thoughtbot code of conduct.

License

Laptop is © 2011-2017 thoughtbot, inc. It is free software, and may be redistributed under the terms specified in the LICENSE file.

About thoughtbot

Laptop is maintained and funded by thoughtbot, inc. The names and logos for thoughtbot are trademarks of thoughtbot, inc.

We are passionate about open source software. See our other projects. We are available for hire.