diff --git a/README.md b/README.md index 5aa485b..8913f71 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ through **Queue → In progress → Done**, then download the day's data as a CS No database, no build step, no npm dependencies. Just Node. +![The volunteer dashboard](docs/screenshots/dashboard-drag.png) + ## Running it ```sh @@ -31,16 +33,24 @@ this machine only. 1. On the main page press **Create repair cafe kanban** and name the event. Tick *randomise the address* if you want a hard-to-guess URL. + + Create form 2. You land on the **sign-in form** at `/`. Leave this open on a tablet or laptop by the door — it clears itself after every submission. + + Sign-in form 3. Open the **dashboard** at `//dashboard` on the volunteers' laptop. There is a link to it at the bottom of the sign-in form. 4. Drag cards between columns. Moving a card into *In progress* asks who is repairing it; moving it into *Done* asks how it went. A card that reaches *Done* without a result is outlined in red until someone fills it in. + + Done card missing a result 5. Click any card's title to see and edit the full record, and to add notes. 6. Press **Download CSV** at the end of the day. + ![The exported CSV](docs/screenshots/csv.png) + On a touch screen, drag a card by its **⠿** grip in the top right corner — that leaves the rest of the card free for scrolling. You can also change a card's status from the detail overlay without dragging at all. diff --git a/docs/screenshots/create.png b/docs/screenshots/create.png new file mode 100644 index 0000000..03c20cf Binary files /dev/null and b/docs/screenshots/create.png differ diff --git a/docs/screenshots/csv.png b/docs/screenshots/csv.png new file mode 100644 index 0000000..f456067 Binary files /dev/null and b/docs/screenshots/csv.png differ diff --git a/docs/screenshots/dashboard-drag.png b/docs/screenshots/dashboard-drag.png new file mode 100644 index 0000000..0414437 Binary files /dev/null and b/docs/screenshots/dashboard-drag.png differ diff --git a/docs/screenshots/done-missing-result.png b/docs/screenshots/done-missing-result.png new file mode 100644 index 0000000..7c8222d Binary files /dev/null and b/docs/screenshots/done-missing-result.png differ diff --git a/docs/screenshots/sign-in.png b/docs/screenshots/sign-in.png new file mode 100644 index 0000000..5f1ae9c Binary files /dev/null and b/docs/screenshots/sign-in.png differ