Skip to content
Zipline Zipline Service Documentation

    Appendix A - Mac setup

    Use this appendix if you are setting up service_docs on a Mac for the first time.

    Install Git

    Section titled “Install Git”

    If Git is not already installed, install Xcode Command Line Tools:

    Terminal window
    xcode-select --install

    Or, if you use Homebrew:

    Terminal window
    brew install git

    Verify:

    Terminal window
    git --version

    Install Node.js LTS

    Section titled “Install Node.js LTS”

    Download Node.js from the Node.js download page and install the LTS version.

    If you use nvm:

    Terminal window
    nvm install --lts
    nvm use --lts

    Node.js also installs npm, which is the tool you use later to run npm ci and npm run dev.

    Verify:

    Terminal window
    node --version
    npm --version

    If both commands show version numbers, Node.js and npm are installed.

    Clone the repository

    Section titled “Clone the repository”

    HTTPS:

    Terminal window
    git clone https://github.com/ZiplineTeam/service_docs.git
    cd service_docs

    SSH:

    Terminal window
    git clone git@github.com:ZiplineTeam/service_docs.git
    cd service_docs

    If clone fails with a permission error, confirm that you are signed in to the right GitHub account and use Appendix D - Check GitHub access to check your repo and write access.

    Install site dependencies

    Section titled “Install site dependencies”

    From the repo root, install the Troubleshooting dependencies:

    Terminal window
    npm ci --prefix site

    Open in VS Code

    Section titled “Open in VS Code”

    Open the service_docs folder in VS Code, then continue with Set up your workspace.