The following is a guide to building and running Stacks locally. You’ll need to be able to build Stacks to contribute to our documentation or add new classes to our CSS library.
You’ll need a full Ruby development environment in order to run our static site generator. Let’s start by opening our Terminal app and installing a few things.
- Install Xcode. You can download it directly, or install via the Mac App Store.
- Install Xcode’s command line tools
- Accept the Xcode license.
sudo xcodebuild -license accept
- To Install a fresh version of Ruby, we’ll use Homebrew. Install it by running
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
- Now you can use Homebrew to install Ruby
brew install ruby
- You’ll need to add
export PATH=/usr/local/opt/ruby/bin:$PATHto your
.bash_profilein your user directory. If a
.bash_profile, create one and add that line to the file.
- Now’s a good time to quit your Terminal and relaunch it. This will make sure your session is aware of the new dependencies we’ve installed. Don’t just close the window, quit the whole app.
Download and install a Ruby+Devkit version from RubyInstaller Downloads. You’ll want to restart your computer before moving on.
There are two common ways to clone a repo:
- Use the command line:
git clone https://github.com/StackExchange/Stacks.git
- Use GitHub’s desktop app.
- Download and install GitHub Desktop.
- Login with your GitHub credentials.
- Clone the Stacks repo.
We use a bunch of NPM dependencies to process and package up Stacks for delivery. You’ll need to install them.
- Install Node & NPM
- Open the Stacks repo in a Terminal window.
- Install the NPM dependencies.
We use Jekyll to generate our site. We use Bundler to install Jekyll and its dependencies.
- Switch to
docswithin the Stacks directory.
- Install Bundler and Jekyll
gem install jekyll bundler. Depending on your environment, you may need to type your machine’s password a few times during this process.
- Install the Bundle
That should do it for all our dependencies. You’re now able to run Stacks.
- From the top level of the Stacks repo, run our main script
- Visit your local copy of Stacks at
Installing dependencies can be frustrating, and we’re here to help. If you’re stuck, the Stacks team is always available in #stacks. If that doesn’t work, try opening an issue.