Github url

laptop

by thoughtbot

thoughtbot /laptop

A shell script to set up a macOS laptop for web and mobile development.

7.9K Stars 1.8K Forks Last release: Not found MIT License 364 Commits 0 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Laptop

Laptop is a script to set up a 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)
  • macOS Mojave (10.14)

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/thoughtbot/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. If not, copy the lines where the script failed into anew 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:

  • Universal Ctags for indexing files for vim tab completion
  • Git for version control
  • OpenSSL for Transport Layer Security (TLS)
  • RCM for managing company and personal dotfiles
  • The Silver Searcher for finding things in files
  • Tmux for saving project state and switching between projects
  • Watchman for watching for filesystem events
  • Zsh as your shell

Heroku tools:

GitHub tools:

  • Hub for interacting with the GitHub API

Image tools:

Programming languages, package managers, and configuration:

  • asdf-vm for managing programming language 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 eof default_docker_machine docker-machine ls grep if then create virtualbox default fi default_docker_machine_running start fancy_echo up old homebrew formulae ... cleanup cask dotfiles rcup>
<p>Write your customizations such that they can be run safely more than once.
See the </p>
<pre class="">mac</pre> script for examples.

<p>Laptop functions such as </p>
<pre class="">fancy_echo</pre> and
<pre class="">gem_install_or_update</pre>
can be used in your <pre class="">~/.laptop.local</pre>.

<p>See the <a href="https://github.com/thoughtbot/laptop/wiki">wiki</a>
for more customization examples.</p>

<h2>Contributing</h2>

<p>Edit the </p>
<pre class="">mac</pre> file.
Document in the <pre class="">README.md</pre> file.
Follow shell style guidelines by using <a href="http://www.shellcheck.net/about.html">ShellCheck</a> and <a href="https://github.com/scrooloose/syntastic">Syntastic</a>.
<pre class="sh">brew install shellcheck
</pre>
<p>Thank you, <a href="https://github.com/thoughtbot/laptop/graphs/contributors">contributors</a>!</p>

<p>By participating in this project,
you agree to abide by the thoughtbot <a href="https://thoughtbot.com/open-source-code-of-conduct">code of conduct</a>.</p>

<h2>License</h2>

<p>Laptop is © 2011-2020 thoughtbot, inc.
It is free software,
and may be redistributed under the terms specified in the <a href="https://github.com/thoughtbot/laptop/blob/master/LICENSE">LICENSE</a> file.</p>

<h2>About thoughtbot</h2>

<p><img src="https://thoughtbot.com/brand_assets/93:44.svg" alt="thoughtbot"></p>

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

<p>We are passionate about open source software.
See <a href="https://thoughtbot.com/community?utm_source=github">our other projects</a>.
We are <a href="https://thoughtbot.com?utm_source=github">available for hire</a>.</p>
</eof>

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.