[MGNLFE-164] Standardize frontend-helpers sample projects Created: 26/Jan/22  Updated: 22/Jul/22  Resolved: 01/Mar/22

Status: Closed
Project: Magnolia Frontend Helpers
Component/s: None
Affects Version/s: None
Fix Version/s: 1.2.2

Type: Story Priority: Major
Reporter: Christopher Zimmermann Assignee: Canh Nguyen
Resolution: Done Votes: 0
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: 16d 2.75h Time Spent: 15d 0.25h
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Issue Links:
dependency
is depended upon by MGNLFE-165 Process for frontend-helpers library ... Closed
is depended upon by MGNLCE-281 INT tests SPA components Closed
is depended upon by MGNLCE-283 INT tests ext.SPA components Closed
documentation
to be documented by MGNLFE-168 DOC: Refactoring of frontend-helpers ... Closed
Sub-Tasks:
Key
Summary
Type
Status
Assignee
MGNLFE-173 Refactor angular sample Sub-task Closed Phong Le Quoc  
MGNLFE-174 Refactor react sample Sub-task Closed Chuong Doan Huy  
MGNLFE-175 Refactor vue sample Sub-task Closed Canh Nguyen  
Template:
Acceptance criteria:
Empty
Task DoD:
[X]* Doc/release notes changes? Comment present?
[X]* Downstream builds green?
[X]* Solution information and context easily available?
[X]* Tests
[X]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Epic Link: SaaS TPR - SPA Tests
Sprint: DevX 4
Story Points: 5
Team: DeveloperX

 Description   

Currently the sample projects for the frontend helpers are hard to use and understand. 
https://git.magnolia-cms.com/projects/MODULES/repos/frontend-helpers/browse/samples

Update the sample projects to make them easy to understand and use and consistant.

They will likely serve as test cases for integration tests.

Sub tasks could be created for the following items. Recommended improvements:

  • Sample projects should be te same in every framework.
  • Sample should include a simple demonstration of each library feature. (List all of the features.)
  • Recommend renaming sample projecs from "spa-angular-minimal" to "spa-angular-sample".
  • Name root pages such that:
    • All sample projects can be loaded on the same magnolia instance.
    • Projects can be loaaded on the same magnolia instance as spa-minimal-headless-demo and spa-website demo.
    • So maybe name them "angular-sample", "react-sample" etc.
  • Include sample content as bootstraps that can be imported.
  • Include CORS and security setup to make them as easy to use as possible.
  • README that describes
    • every step necessary to run
    • the features in the sample. Things that are the same in every sample could be put in a shared README higher up in the directory structure.

Generated at Mon Feb 12 05:44:52 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.