Uploaded image for project: 'Magnolia Frontend Helpers'
  1. Magnolia Frontend Helpers
  2. MGNLFE-164

Standardize frontend-helpers sample projects

    XMLWordPrintable

Details

    • Story
    • Resolution: Done
    • Major
    • 1.2.2
    • None
    • None
    • None
    • DevX 4
    • 5

    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.

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                canh.nguyen Canh Nguyen
                czimmermann Christopher Zimmermann
                DeveloperX
                Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Checklists

                    Task DoD

                    Time Tracking

                      Estimated:
                      Original Estimate - Not Specified
                      Not Specified
                      Remaining:
                      Remaining Estimate - Not Specified
                      Not Specified
                      Logged:
                      Time Spent - 16d 2.75h
                      16d 2.75h