How to install Zoneless on Mac

Before you start

These are one-time installs. If you have used Terminal before, you may have them already — the first step checks.

1. 1

   Install Git

   Apple opens a small installer.

   Type this into Terminal, then press Return.

   Copy the command for step 1

   xcode-select --install

   You know this worked when: Git responds with a version number

2. 2

   Install Node LTS

   Choose the macOS Installer (.pkg).

   Open download ↗

   You know this worked when: Node responds with a version number

Install Zoneless

1. 3

   Open Terminal

   Keep it open beside this page.

   You know this worked when: Terminal is open

2. 4

   Check Git and Node

   Git and the current Node LTS are required.

   Type this into Terminal, then press Return.

   Copy the command for step 4

   git --version
   node --version

   You know this worked when: Git and Node respond with version numbers

3. 5

   Install Docker Desktop

   Open it once so the engine starts, then come back here.

   Open download ↗

   You know this worked when: docker --version prints a version

4. 6

   Copy Zoneless to this Mac

   Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.

   Copy the command for step 6

   cd ~
   if [ ! -d zoneless/.git ]; then
   git clone https://github.com/zonelessdev/zoneless.git
   fi

   You know this worked when: A zoneless folder appears

5. 7

   Open the Zoneless folder

   Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.

   Copy the command for step 7

   cd ~
   cd zoneless

   You know this worked when: Your terminal prompt is inside the zoneless folder

6. 8

   Use the reviewed version

   Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.

   Copy the command for step 8

   cd ~/zoneless
   git checkout 05b387534c94c06828c1720f2998421af42e3aa4

   You know this worked when: Git reports the reviewed commit

7. 9

   Install dependencies

   Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.

   Copy the command for step 9

   cd ~/zoneless
   npm install

   You know this worked when: The command finishes without an error

8. 10

   Get a APP_SECRET key

   Sign in, create a key, and copy it.

   Open the page ↗

   You know this worked when: You have a key on your clipboard

9. 11

   Copy the env file

   Then open .env and set APP_SECRET.

   Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.

   Copy the command for step 11

   cd ~/zoneless
   cp .env.example .env

   You know this worked when: .env has APP_SECRET set

10. 12

    Run Zoneless

    Keep Terminal open.

    Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.

    Copy the command for step 12

    cd ~/zoneless
    npm run dev

    You know this worked when: localhost:4203 responds

11. 13

    Open it in your browser

    If a different port was picked, open that one instead.

    Open localhost:4203 ↗

    You know this worked when: The app loads in the browser

12. 14

    Try it

    Zoneless should be open in your browser.

    You know this worked when: Zoneless works

If something goes wrong

Nothing here can damage your computer, and every step can be run again safely. If a command fails, the usual cause is the step before it not having finished.

Still stuck? Tell us what happened and we will fix the guide. Include the step number and we can usually reproduce it.