nimblehq / laptop

A shell script which turns your OS X laptop into an awesome web development machine

---

Laptop is a script to set up an OS X laptop for web 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:

• OS X Big Sur (11.6)
• OS X Monterey (12.3) both Apple Silicon and Intel

Older versions may work but aren't regularly tested. This script is tested on the most recent and its previous version.

Install

Download, review, then execute the script:

curl --remote-name https://raw.githubusercontent.com/nimblehq/laptop/master/mac
less mac
bash mac 2>&1 | tee ~/laptop.log

Choose the additional packages when the prompts appear:

Do you want to install Web's dependencies? [y|N]
Do you want to install iOS's dependencies? [y|N]
Do you want to install Android's dependencies? [y|N]

What it sets up

Default

• Ruby stable for writing general-purpose code
• Bundler for managing Ruby libraries
• Keybase to have encrypted team communication
• 1Password the world’s most-loved password manager
• Slack for general team communication
• Google Chrome as the default browser
• Skitch get your point across with fewer words using annotation, shapes and sketches
• Postman a collaboration platform for API development
• iTerm2 a replacement for Terminal
• git distributed revision control system
• Github CLI GitHub’s official command line tool
• Github Desktop GitHub’s official GUI tool
• Git Large File Storage an open source Git extension for versioning large files
• Homebrew for managing operating system libraries
• RVM for managing versions of Ruby
• NVM for managing versions of Node.JS
• Zsh as your shell
• oh-my-zsh to spice up your shell
• VS Code code editor
• gpg2 GNU Pretty Good Privacy (PGP) package
• libyaml YAML Parser
• coreutils GNU File, Shell, and Text utilities

Web

• Go programming language to build simple/reliable/efficient software
• Elixir functional metaprogramming aware language built on Erlang VM
• Docker for managing project dependencies
• Heroku CLI for interacting with the Heroku API
• AWS CLI official Amazon AWS command-line interface
• ImageMagick for cropping and resizing images
• Postgres for storing relational data
• Yarn JavaScript package manager
• Phrase for interacting with the Phrase API
• JetBrains Toolbox for managing JetBrains tools the easy way

iOS

• Cocoapods a dependency manager for Cocoa projects
• Figma helps teams create, test, and ship better designs from start to finish
• Proxyman enables developers to observe and manipulate HTTP/HTTPS requests
• Atlassian SourceTree a free Git client for Mac
• XCode iOS IDE

Android

• Temurin OpenJDK from the Adoptium
• Android Studio Android IDE
• Android SDK Software Development Kit for Android

It should take less than 15 minutes to install (depending on your machine and internet speed).

M1 incompatible dependecies

• Keybase to have encrypted team communication

It will omit all these dependencies above while running the script in the M1 machines.

Customize in ~/.laptop.local

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

#!/bin/sh

cask "dropbox"
cask "firefox"

brew "tree"

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,brew_install_or_upgrade, and gem_install_or_update can be used in your ~/.laptop.local.

See the wiki for more customization examples.

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.

Contributing

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

brew install shellcheck

License

It is free software, and may be redistributed under the terms specified in the LICENSE file.

About

This project is maintained and funded by Nimble.

Inspired by the project of Thoughtbot.

We love open source and do our part in sharing our work with the community! See our other projects or hire our team to help build your product.