[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: |
|
|||||||||||||||||||||||||
| 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: | ||||||||||||||||||||||||||
| Work Started: | ||||||||||||||||||||||||||
| Approved: |
Yes
|
| Description |
|
The README files should include information:
|
| 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 |