How to install OpenQR 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

   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 OpenQR

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

   git --version
   node --version

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

3. 5

   Copy OpenQR 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

   cd ~
   if [ ! -d OpenQR/.git ]; then
   git clone https://github.com/amaurylacalmette-ui/OpenQR.git
   fi

   You know this worked when: A OpenQR folder appears

4. 6

   Open the OpenQR 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

   cd ~
   cd OpenQR

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

5. 7

   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

   cd ~/OpenQR
   git checkout 13e2ae650381f2b3cbf3480bdc65d2f0e287053d

   You know this worked when: Git reports the reviewed commit

6. 8

   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

   cd ~/OpenQR
   npm install

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

7. 9

   Get a POSTGRES_PASSWORD key

   Sign in, create a key, and copy it.

   Open the page ↗

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

8. 10

   Copy the env file

   Then open .env and set POSTGRES_PASSWORD.

   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

   cd ~/OpenQR
   cp .env.example .env

   You know this worked when: .env has POSTGRES_PASSWORD set

9. 11

   Run OpenQR

   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

   cd ~/OpenQR
   npm run dev

   You know this worked when: localhost:3000 responds

10. 12

    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

11. 13

    Try it

    OpenQR should be open in your browser.

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