mautic / mautic/user-documentation
Add NPM as a requirement for the installation of Mautic
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 22
- Forks
- 76
- Avg merge
- 22h 9m
- Merged PRs (30d)
- 33
Description
This needs to be in our end-user docs and also at mautic.org/download/requirements - we now require NPM because it's used for building JS dependencies but people are coming up against problems because it's not clearly documented.
Forum threads:
https://forum.mautic.org/t/unable-to-install-mautic-5-0-2-with-composer/30670
https://forum.mautic.org/t/composer-setup-for-mautic-5-now-needs-npm/29823
https://forum.mautic.org/t/mautictwigtemplatesbundle-not-shown/30595/6
- Perhaps we can document the specific extensions needed for installing Mautic (@jos0405 do you have this documented already somewhere?)
- We should include this in the composer docs updates, also.
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
Start by reviewing the end-user installation and Composer documentation, then compare it with the requirements page at mautic.org/download/requirements. Use the linked forum threads to confirm the NPM and extension requirements; the work is done when both documentation locations clearly list the requirements needed for installation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100