Skip to content

Latest commit

 

History

History
121 lines (92 loc) · 4.6 KB

File metadata and controls

121 lines (92 loc) · 4.6 KB
Odoo Community Association

Farm Onboarding

Alpha License: AGPL-3 ledoent/farm-pack

First-run setup wizard for the farm pack. Five screens — welcome, your farm (name + acres + ZIP), what you grow or raise (multi-select from 12 enterprise types), how you keep books today (QBO / QBD / Excel / paper / nothing), done — with a state machine, progress bar, save-as-you-go, and back/next/skip/restart actions.

The wizard surfaces itself two ways:

  • Navbar bell. A leaf icon with a red badge dot appears in the systray when the current farm user has an unfinished session. Click it to jump straight into the wizard. The bell is hidden for users outside farm_base.group_farm_user and disappears once the session is marked done.
  • Farm → Setup Wizard menu item. Same destination, accessible at any time for a re-run.

The form itself is a regular Odoo form view with state-conditional groups so sessions persist across browser closes. A richer custom- chrome design pass lives in a follow-on PR (Step 2 of the UX refinement plan).

Adds 12 pre-loaded farm.enterprise.type records (eggs, vegetables, fruit, herbs, orchard, cattle, dairy, poultry, hogs, sheep/goats, value- added, workshops) with emoji icons — these drive product catalog and report pre-configuration in downstream modules.

Each user gets their own session per company, so multiple farm-users on the same company each get an independent walkthrough. The umbrella farm_pack module's post_init_hook seeds a session for every existing internal farm user on install; new users created later pick one up lazily on first wizard open.

Important

This is an alpha version, the data model and design can change at any time without warning. Only for development or testing purpose, do not use in production. More details on development status

Table of contents

  1. Look for the leaf icon + red dot in the navbar. That's the onboarding bell — click it to jump into the wizard. (Or use Farm → Setup Wizard for the same destination.)
  2. Click Next to step through: Welcome → Your Farm → What You Grow → Books Today → All Set.
  3. Each screen saves on Next/Back so closing the browser doesn't lose progress. Skip jumps straight to Done.
  4. Once done, the bell disappears and the Farm menu's other items (Eggs, CSA, Markets, Delivery, QuickBooks) are where the actual work happens — the wizard pre-tells the pack what to surface for your operation.

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

  • Ledo Enterprises

Current maintainer:

dkendall

This module is part of the ledoent/farm-pack project on GitHub.

You are welcome to contribute.