How to install OpenNotes on Windows

Before you start

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

1. 1

   Install Git

   Run the installer, then reopen PowerShell.

   Open installer ↗

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

2. 2

   Install Node LTS

   Run the LTS installer, then reopen PowerShell.

   Open download ↗

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

Install OpenNotes

1. 3

   Open PowerShell

   Keep it open beside this page.

   You know this worked when: PowerShell is open

2. 4

   Check Git and Node

   Git and the current Node LTS are required.

   Type this into PowerShell (not Command Prompt), then press Enter.

   Copy the command for step 4

   git --version
   node --version

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

3. 5

   Copy OpenNotes to this PC

   Type this into PowerShell (not Command Prompt), then press Enter. 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 5

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

   You know this worked when: A OpenNotes folder appears

4. 6

   Open the OpenNotes folder

   Type this into PowerShell (not Command Prompt), then press Enter. 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 ~
   cd OpenNotes

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

5. 7

   Use the reviewed version

   Type this into PowerShell (not Command Prompt), then press Enter. 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 ~/OpenNotes
   git checkout 215d1bfb5e1c5b3aad1abea6ecdb727c3ed4db02

   You know this worked when: Git reports the reviewed commit

6. 8

   Install dependencies

   Type this into PowerShell (not Command Prompt), then press Enter. 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 ~/OpenNotes
   npm.cmd install

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

7. 9

   Run OpenNotes

   Keep PowerShell open.

   Type this into PowerShell (not Command Prompt), then press Enter. 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 ~/OpenNotes
   npm.cmd run dev

   You know this worked when: localhost:3000 responds

8. 10

   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

9. 11

   Try it

   OpenNotes should be open in your browser.

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