How to install Reactive Resume 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 Reactive Resume

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 pnpm

   The app is a pnpm project.

   Type this into Terminal, then press Return.

   Copy the command for step 5

   mkdir -p "$HOME/.npm-global/bin"
   npm install -g --prefix "$HOME/.npm-global" pnpm
   grep -qsxF 'export PATH="$HOME/.npm-global/bin:$PATH"' "$HOME/.zshrc" || echo 'export PATH="$HOME/.npm-global/bin:$PATH"' >> "$HOME/.zshrc"
   export PATH="$HOME/.npm-global/bin:$PATH"

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

4. 6

   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

5. 7

   Copy Reactive Resume 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 7

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

   You know this worked when: A reactive-resume folder appears

6. 8

   Open the Reactive Resume 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 8

   cd ~
   cd reactive-resume

   You know this worked when: Your terminal prompt is inside the reactive-resume folder

7. 9

   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 9

   cd ~/reactive-resume
   git checkout 14fb49b7149f6f13bdb1fff3659feec5200bf4df

   You know this worked when: Git reports the reviewed commit

8. 10

   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 10

   cd ~/reactive-resume
   pnpm install --frozen-lockfile

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

9. 11

   Get a AUTH_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

10. 12

    Copy the env file

    Then open .env and set AUTH_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 12

    cd ~/reactive-resume
    cp .env.example .env

    You know this worked when: .env has AUTH_SECRET set

11. 13

    Get a ENCRYPTION_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

12. 14

    Copy the env file

    Then open .env and set ENCRYPTION_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 14

    cd ~/reactive-resume
    cp .env.example .env

    You know this worked when: .env has ENCRYPTION_SECRET set

13. 15

    Run Reactive Resume

    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 15

    cd ~/reactive-resume
    pnpm run start

    You know this worked when: localhost:3000 responds

14. 16

    Open it in your browser

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

    Open localhost:3000 ↗

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

15. 17

    Try it

    Reactive Resume should be open in your browser.

    You know this worked when: Reactive Resume 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.