What you end up with
Potluck running in your browser, on your own computer. It is free, and it stays free. It opens with Sign in with publik; no trial, no subscription.
- Time
- About 28 minutes
- Steps
- 11
- Cost
- Free
Before you start
These are one-time installs. If you have used Terminal before, you may have them already — the first step checks.
Install Git
Apple opens a small installer.
Type this into Terminal, then press Return.
xcode-select --installYou know this worked when: Git responds with a version number
Install Node LTS
Choose the macOS Installer (.pkg).
Open downloadYou know this worked when: Node responds with a version number
Install Potluck
Open Terminal
Keep it open beside this page.
You know this worked when: Terminal is open
Check Git and Node
Git and the current Node LTS are required.
Type this into Terminal, then press Return.
git --version node --versionYou know this worked when: Git and Node respond with version numbers
Copy Potluck 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.
cd ~ if [ ! -d potluck/.git ]; then git clone https://github.com/VedSoni-dev/potluck.git fiYou know this worked when: A potluck folder appears
Open the Potluck 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.
cd ~ cd potluckYou know this worked when: Your terminal prompt is inside the potluck folder
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.
cd ~/potluck git checkout ccaffae6c7d2658df34b522a55b9de32b38d83afYou know this worked when: Git reports the reviewed commit
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.
cd ~/potluck npm installYou know this worked when: The command finishes without an error
Run Potluck
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.
cd ~/potluck npm run devYou know this worked when: localhost:3000 responds
Open it in your browser
If a different port was picked, open that one instead.
Open localhost:3000You know this worked when: The app loads in the browser
Try it
Potluck should be open in your browser.
You know this worked when: Potluck 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.