Skip to content

Latest commit

 

History

History
154 lines (118 loc) · 5.74 KB

README.md

File metadata and controls

154 lines (118 loc) · 5.74 KB
Raw

Laptop

Build Status

Laptop is a script to set up an OS X computer 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.

This particular version of the script is geared toward beginners who want to set up a Ruby on Rails environment on their Mac. More advanced users can easily customize the script to install additional tools. To see an example of a more advanced script, check out 18F/laptop.

Requirements

I support clean installations of these operating systems:

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

Install

Begin by opening the Terminal application on your Mac. The easiest way to open an application in OS X is to search for it via Spotlight. The default keyboard shortcut for invoking Spotlight is command-Space. Once Spotlight is up, just start typing the first few letters of the app you are looking for, and once it appears, press return to launch it.

In your Terminal window, copy and paste each of these three commands one at a time, then press return after each one to download, review, and execute the script respectively:

curl --remote-name https://raw.githubusercontent.com/monfresh/laptop/master/mac
cat mac
bash mac 2>&1 | tee ~/laptop.log && source ~/.rvm/scripts/rvm

I also have more detailed instructions with a video in the Wiki.

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 me. Or, attach the whole log file as an attachment.

What it sets up

  • Flux for adjusting your Mac's display color so you can sleep better
  • GitHub for Mac for setting up your SSH keys automatically
  • Heroku Toolbelt for deploying and managing Heroku apps
  • Homebrew for managing operating system libraries
  • Homebrew Cask for quickly installing Mac apps from the command line
  • Homebrew Services so you can easily stop, start, and restart services
  • hub for interacting with the GitHub API
  • Postgres for storing relational data
  • Qt for headless JavaScript testing via Capybara Webkit
  • RVM for managing Ruby versions (includes Bundler and the latest Ruby)
  • Sublime Text 3 for coding all the things
  • Zsh as your shell

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

Customize in ~/.laptop.local

Your ~/.laptop.local is run at the end of the mac script. Put your customizations there. This repo already contains a .laptop.local you can use to get started. It lets you install the following tools (commented out by default):

  • Atom - GitHub's open source text editor
  • CloudApp for sharing screenshots and making an animated GIF from a video
  • Firefox for testing your Rails app on a browser other than Chrome or Safari
  • iTerm2 - an awesome replacement for the OS X Terminal

To install any of the above tools, uncomment them from .laptop.local by removing the #. For example, to install CloudApp, your .laptop.local should look like this:

#!/bin/sh

# brew_cask_install 'atom'
brew_cask_install 'cloud'
# brew_cask_install 'firefox'
# brew_cask_install 'iterm2'

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

# Go to your OS X user's root directory
cd ~

# Download the sample file to your computer
curl --remote-name https://raw.githubusercontent.com/monfresh/laptop/master/.laptop.local

Credits

This laptop script is inspired by thoughbot's laptop script.

Public domain

thoughtbot's original work remains covered under an MIT License.

My work on this project is in the worldwide public domain, as are contributions to my project. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.