[MGNLFE-556] Updates README Created: 29/Jun/23  Updated: 28/Aug/23  Resolved: 11/Jul/23

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

Type: Improvement Priority: Neutral
Reporter: Phong Le Quoc Assignee: Phong Le Quoc
Resolution: Fixed Votes: 0
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: 7h Time Spent: 7h
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Sub-Tasks:
Key
Summary
Type
Status
Assignee
MGNLFE-557 Implement Sub-task Completed Phong Le Quoc  
MGNLFE-559 Review Sub-task Closed Rishab Dhar  
MGNLFE-561 PiQA Sub-task Completed Rishab Dhar  
MGNLFE-562 QA Sub-task Completed Javier Benito  
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: SPA Editor Backlog
Sprint: DevX 41
Story Points: 1
Team: DeveloperX
Work Started:
Approved:
Yes

 Description   

The README files should include information:

  • How to run samples with local change by using lerna, our own scripts, yalc
  • How to run other projects, ex: hello saas, minimal with our local code


 Comments   
Comment by Phong Le Quoc [ 29/Jun/23 ]

At least, we should have

There are three ways to build the changes made in the modules and consume those changes in the samples projects. 

* [Scripts](https://git.magnolia-cms.com/projects/MODULES/repos/frontend-helpers/browse/scripts/README.md)
* [Scripts](https://git.magnolia-cms.com/projects/MODULES/repos/frontend-helpers/browse/scripts/README.md) - Some scripts to run samples quickly and consistency.
* [Yalc](https://www.viget.com/articles/how-to-use-local-unpublished-node-packages-as-project-dependencies/) - A tool that allows you automatically push through all the changes made in the development package to all downstream projects without having to rebuild all the downstream projects manually.
* [Lerna](https://lerna.js.org/) - Steps to run a sample:
  * npm install
  * npm run build
  * npm run test
  * cd ./samples/angular-sample
  * npm start 
Comment by Phong Le Quoc [ 29/Jun/23 ]

We should have step by step for Yalc also

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