Laptop is a script to set up a macOS environment for web development.

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

Requirements

• macOS Sonoma (14.4) or higher

[!NOTE] Both Apple Silicon and Intel are supported

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

Applications:

• 1Password the world’s most-loved password manager
• Google Chrome as the default browser
• Keybase to have encrypted team communication
• Postman a collaboration platform for API development
• Skitch get your point across with fewer words using annotation, shapes and sketches
• Slack for general team communication
• VS Code code editor

Source Code versioning:

• git distributed revision control system
• Git Large File Storage an open-source Git extension for versioning large files
• Github CLI GitHub’s official command line tool
• Github Desktop GitHub’s official GUI tool

Terminal:

• iTerm2 a replacement for Terminal
• oh-my-zsh to spice up your shell
• Zsh as your shell

Utilities:

• asdf to manage all your runtime versions with one tool
• Bundler for managing Ruby libraries
• coreutils GNU File, Shell, and Text utilities
• gpg2 GNU Pretty Good Privacy (PGP) package
• Homebrew for managing operating system libraries
• mas CLI A simple CLI for the Mac App Store.
• libyaml YAML Parser

Web

Tools:

• Docker for managing project dependencies
• ImageMagick for cropping and resizing images
• Yarn JavaScript package manager
• JetBrains Toolbox for managing JetBrains tools the easy way

Command Line Interfaces:

• AWS CLI official Amazon AWS command-line interface
• Heroku CLI for interacting with the Heroku API
• Phrase CLI for interacting with the Phrase API

Plugins for asdf:

• Elixir functional metaprogramming aware language built on Erlang VM
• Go programming language to build simple/reliable/efficient software
• Nodejs JavaScript runtime environment
• Ruby dynamic, open-source programming language with a focus on simplicity and productivity

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.