openedx / openedx/frontend-app-learner-record
update README/package.json for Tutor based development
Open
Nobody has claimed this yet.
documentation
help wanted
- Dominant language
- JavaScript
- Stars
- 7
- Forks
- 26
- Avg merge
- 3m
- Merged PRs (30d)
- 1
Description
We should update the README to document how to develop this MFE against tutor
Notes:
- https://github.com/overhangio/tutor-credentials?tab=readme-ov-file#learner-record-ui
- add
devscript topackage.jsonsonpm run devworks (see other tutor-supported MFEs such asfrontend-app-learningfor examples)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Update README and package.json, using the tutor-credentials learner-record-ui notes and frontend-app-learning as references. First compare the development instructions and scripts in those references. Done means the README documents Tutor-based development and npm run dev works for this MFE.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation, frontend
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100