Product Tour - Welcome to FlowFuse

[joepavitt]

Description

• Add infrastructrue to render interactive product tours
  • ShepherdJS to run the tour logic
  • VueX store to track state on whether we should be showing tour or not
  • Tour composable that wraps ShepherdJS
  • Integrate PH analytics so we can track progression through the tours
• Adds the first "welcome" tour
  • Set to active if user arrives via the verify e-mail screen

Related Issue(s)

Closes #2721

Checklist

• I have read the contribution guidelines
• Suitable unit/system level tests have been added and they pass

Screen.Recording.2024-08-15.at.15.40.10.mov

[joepavitt]

Example PH Funnel to track progress:

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.33%. Comparing base (1818cf0) to head (bcb4ab9).
Report is 14 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #4383   +/-   ##
=======================================
  Coverage   78.33%   78.33%           
=======================================
  Files         293      293           
  Lines       13567    13567           
  Branches     3052     3052           
=======================================
  Hits        10628    10628           
  Misses       2939     2939           

Flag	Coverage Δ
backend	78.33% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Steve-Mcl]

Should we not be conditioning the tour or adapting to what is present in the team?

Also, is this intended for FFC or FFD also?
Because while we do auto create an application and instance, FFD might not 🤷

As an example, a user joining an existing team and signing in for the first time, when they access the existing team that has no instances or does have devices - it throws off the dialog.

[joepavitt]

Great point re: dedicated and joining existing teams... I'll adjust it accordingly. May need to be conditional (not sure how yet) on that last "Open Editor" step.

[joepavitt]

@gstout52 FYI - tour script is here if you want to review. @Steve-Mcl made great points that we need to make this host agnostic, so this covers all hosting options quite nicely, and even for new users coming into an existing team, full of resources.

[Steve-Mcl]

Agnostic language reads better. I feel this can support varying setups.

[Steve-Mcl]

@joepavitt I wont merge until @gstout52 has had a chance to read and review.