Docs menu: Getting started

Start here

Getting started

Run Larder on your own computer, become its owner, and work through the five first steps on Today.

1. Install rer

Larder runs with rer, the Run Edit Run command. Install it once per computer:

curl -fsSL https://runeditrun.com/install.sh | sh

If you prefer npm, npm install -g @runeditrun/rer does the same. Larder needs Node 22 or later and pnpm 10.12.4, on macOS, Linux or Windows with WSL2; rer fetches the exact Node version Larder declares when your computer does not have it.

2. Get Larder and start it

git clone https://github.com/just-every/run-larder.git
cd run-larder && rer dev

rer dev installs everything Larder needs, makes you the owner and prints a line starting RER_OPEN with a link. Open that link on the same computer: Larder opens signed in as you. Treat the link like a password; anyone who has it is signed in as the owner.

To set up for a real mailbox instead of the local one, run the steps yourself:

rer install
rer setup --owner-email you@example.com
rer dev

3. Finish setup

The first time you open the app, Larder asks you to review the owner of this installation: your name and email. Tick I confirm this owner account is ready to use. and press Finish setup. Until you do, the installation's home page says it is waiting for its owner.

A new installation starts empty. There are no sample items, stock or orders; everything you see is what you or your team recorded.

4. The five first steps

Today shows a Getting started card until each step is done:

  1. Add your locations and items, or move them in from Odoo. Add them under More โ†’ Items, contacts and locations, or bring them across with Move in from Odoo.
  2. Record counted opening stock with its evidence. On Stock, record what is on each shelf, when it was counted, who counted it and the count sheet or photo. See Stock and counts.
  3. Give each made item a bill of materials. Under Make & buy โ†’ Bills of materials. See Make and buy.
  4. Confirm your first order and reserve its stock. See Take an order.
  5. Invite your team and give each person a role. See People and roles.

Each step ticks itself off when the record exists. When all five are done the card goes away and Today shows only what needs attention.

5. Every morning

Today answers what needs attention: an Exceptions list (what is short, late, quarantined, unreconciled or rejected in a move-in) and Needs a person (drafts and proposals waiting for someone with the authority to approve them). The red count beside Today in the menu is the number of items on that page.

Stop Larder with rer dev --stop or Ctrl-C. Your records stay on this computer in the checkout's .wrangler/state folder; Backup and restore shows how to keep a copy.

Next: Take an order