Skip to content

Quick start

You need a machine with Go, nothing else. The commands run in the core/ folder of Nota’s source.

It is a single program.

Terminal window
go build -o nota ./cmd/nota
Terminal window
./nota init my-nota

This creates a folder with everything it takes:

  • the database, one SQLite file;
  • the rules and Brief templates that ship (conf.d/);
  • two lists to fill in (lists/);
  • a probe that reads them and watches this machine (probe.json);
  • two tokens: one for the probe, and yours for the dashboard, which is shown exactly once.

nota init never overwrites what is already there.

Terminal window
cd my-nota && ../nota serve

Open http://127.0.0.1:8080 and sign in with the token. You see something at once: the example rows from the two lists — a tax deadline, an invoice, rent, a depreciation — and this machine with disk, memory and load.

nota serve runs the core and, because a probe.json lies beside it, the probe in the same process.

Open the two files under lists/ in a spreadsheet or an editor and overwrite the example rows. Nota reads them again every minute. When an invoice is paid, write a date in its done column (erledigt in the German templates that nota init writes): it is done and booked.

If you would rather keep the sheet online, publish it as CSV and put a url in probe.json in place of path.

The columns are described under lists.