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.

This project also creates a laptop.local file that continues with other Sonder related setup lines for the flatbook repository.

Requirements

We support bash and zsh on:

• macOS Mavericks (10.9)
• macOS Yosemite (10.10)
• macOS El Capitan (10.11)
• macOS Sierra (10.12)
• macOS Mojave (10.14)
• macOS Catalina (10.15)
• macOS BigSur (11.1)

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/flatbook/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

Debugging

Your last Laptop run will be saved to ~/laptop.log. Read through it to see if you can debug the issue yourself. If not, copy the lines where the script failed into a new GitHub Issue for us. Or, attach the whole log file as an attachment.

What it sets up

macOS tools:

• Homebrew for managing operating system libraries.

Unix tools:

• Exuberant Ctags for indexing files for vim tab completion
• Git for version control
• OpenSSL for Transport Layer Security (TLS)
• The Silver Searcher for finding things in files
• Tmux for saving project state and switching between projects
• Zsh as your shell

Image tools:

• ImageMagick for cropping and resizing images

Testing tools:

• Qt 5 for headless JavaScript testing via Capybara Webkit

Programming languages, package managers, and configuration:

• awscli for managing aws services
• rbenv for managing ruby versions
• nvm for managing node versions
• Bundler for managing Ruby libraries
• 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
• Redis for storing key-value data

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.

This is 18F's [example laptop.local](curl --remote-name https://raw.githubusercontent.com/18F/laptop/master/.laptop.local) that lets you install the following tools and apps:

• Atom - GitHub's open source text editor
• Exuberant Ctags for indexing files for vim tab completion
• Firefox for testing your website on a browser other than Chrome
• iTerm2 - an awesome replacement for the OS X Terminal
• reattach-to-user-namespace to allow copy and paste from Tmux
• Tmux for saving project state and switching between projects
• Vim for those who prefer the command line
• Spectacle - automatic window manipulation

Contributing

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

brew install shellcheck