Provide installation instructions
- Dominant language
- HTML
- Stars
- 5
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
**Is your feature request related to a problem? Please describe.**
I am trying to figure out how morphir works, and I stumbled upon morphir-dapr. I see no installation instructions, so I'm left on my own devices. Noticing a `package.json`, I assume it's using node and try some `npm` commands.
```
$ npm run build
...
> del dist
sh: 1: del: not found
```
...tweak `package.json`, replace `del` with `rm -rf`, and try again:
```
$ npm run build
...more stuff this time...
sh: 1: ncc: not found
```
I've never heard of `ncc`, google doesn't help; I give up.
**Describe the solution you'd like**
Most open source projects include building instructions in their README, as well as system requirements.
**Describe alternatives you've considered**
For now I'll try and compile the examples without using morphir-dapr.
**Additional context**
I'm using a recent Ubuntu Linux.
Contributor guide
Research direction
Start with package.json and the README, then inspect the npm run build command and its del and ncc dependencies on Ubuntu. Document the system requirements, dependency-installation steps, and build instructions so a newcomer can follow them without modifying package.json or guessing what ncc is.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100