Sign in Talk to us Free trial
Free trial

Design and software studio
Colour

The Get running checklist

Follow the first-run checklist that takes you from a new install to your first job in about ten minutes, and skip or reopen any item.

For
OwnerAdministrator
Hosting
Any hosting
Devices
All devices
Business
All businesses

Checked against Pop Street Dispatch 0.1.0

Get running is a short checklist for a new install. You will be able to finish the required items, skip the optional ones and reopen any of them later. Nothing on it blocks the product.

Before you start #

You need the owner or manager role. The checklist is yours to work through, and the rest of your team can use Dispatch while you do.

The items #

ItemWhat you doSkippable
Tell us who you areChoose just you or a business. A business also gives its type and size.No
Add your keyEnter your licence key or start the trial.Yes
Add business detailsBusiness name, a two letter country code and a region. Currency, time zone, phone, website and address are optional.No
Pick a templateChoose a service list and price rules.Yes
Bring your dataImport customers, vehicles or drivers from a CSV file.Yes
Connect another productEnter or show a six character pairing code.Yes
Take the tourFive short coach marks over the real screens, about a minute.Yes
Create your first jobTake your first real tow call.No
Check your backupOne backup exists.No
Add a driverCreate a driver record.Yes

Business types are towing, vehicle repair, taxi or ride, courier, mixed fleet and other. Sizes are 1, 2-5, 6-20, 21-100 and 100+.

Steps #

  1. Open Get running. A progress label such as "3 of 10" shows how far you are.
  2. Work down the list. An item finishes by itself when the work exists: a first tow call, a backup or a driver counts as soon as it is in your records. Other items finish when you mark them.
  3. Skip an optional item with Skip. A skipped item counts as done in the progress and carries the badge "Skipped" with the action "Do it now".
  4. Press Do it now on a skipped item whenever you are ready.
  5. When every required item is done or finished, the list is complete. The required items are who you are, the licence, business details, your first job and a backup.

Good to know #

  • Your answers save as you go. If you close the app halfway, you come back to the same place, and the "Restored your last session" bar returns any unfinished draft.
  • The checklist's part of the daily check-in carries item ids and a done flag for each, with no value you typed.
Technical details
  • GET /onboarding returns the items, the progress, required_done, complete, the target minutes and the tour. POST /onboarding/{item}/complete and POST /onboarding/{item}/skip change an item. These calls are for the owner and manager.
  • Business details save as the business name (shop_name), country, region, currency and timezone settings.
  • Skipping a required item answers conflict (409).
  • Finishing an item before its work exists answers conflict (409): do the work, then check again.
  • The checklist comes from onboarding/flow.json, checked at build time.

If something goes wrong #

  • Skipping a required item: the item is required, so finish it.
  • "finishes when the work is done. Do it, then check again.": create the call, backup or driver first.
  • validation_failed (422) on country: use two letters such as US. On currency: three letters such as USD. On timezone: use a name from the international time zone database, such as America/Chicago or Asia/Kolkata.