HOFF-113: updating hof getting started guidance to reference the skeleton application#28
Conversation
…eton app and not the cli generator
| hof is built in [node.js](https://nodejs.org/en/), and so you'll need that installed first. At present all versions 4 and above are supported, although it is recommended that you use the [latest LTS version](https://github.com/nodejs/LTS#lts-schedule). | ||
|
|
||
| hof also requires npm version 3 or greater. You can check your installed version by running `npm -v` and update to the latest version by running `npm install -g npm@latest`. | ||
| hof also requires npm version 3 or greater, and yarn. You can check your installed versions by running `npm -v` and `yarn -v` and update to the latest versions by running `npm install -g npm@latest` and `npm install -g yarn`. |
There was a problem hiding this comment.
looking at package.json, actually requires npm >= 6.14.0, not version 3 or greater. I think it would be a matter of the team's preference whether to use npm or yarn, using both wouldn't make sense for development, at least. We could add the Yarn version to the 'engines' field if needed, although I haven't tested it and can't suggest the minimum required version.
package.json engines ref:
"engines": {
"node": ">=10.22.1",
"npm": ">=6.14.0"
}
I would suggest to reword it, to add a bit more details and context perhaps:
| hof also requires npm version 3 or greater, and yarn. You can check your installed versions by running `npm -v` and `yarn -v` and update to the latest versions by running `npm install -g npm@latest` and `npm install -g yarn`. | |
| HOF requires Node.js version 10.22.1 or greater and npm version 6.14.0 or greater. | |
| While you can use either npm or yarn for package management, the test scripts for hof expect yarn to be available. | |
| You can check your installed versions by running `node -v`, `npm -v`, and `yarn -v` and update to the latest versions by running `npm install -g npm@latest` and `npm install -g yarn`. |
There was a problem hiding this comment.
@dk4g thanks for the suggestions! Makes sense to me, I don't know the ins and outs of the framework, so I'm happy to take your advice and reword the guide to reflect the right approach.
There was a problem hiding this comment.
Hi a previous senior dev had some issues with dependencies inside dependencies with npm but he was able to fix the issue with yarn so he switched hof to yarn. I would just stick to yarn in docs and our framework and not npm. We use yarn.lock in most of our prod services. We should check though across other services.
We need to be aligned on this so let's discuss in a tech session and update our docs to reflect we support yarn and can't guarantee the framework's compatibility with npm
What?
Updating hof getting started guidance to reference the hof-skeleton application instead of the generator cli.
Why?
The generator cli is outdated and has been replaced with the hof-skeleton app as a simple, bare bones approach to getting started with hof.
How?
Updated the getting started section of the hof guide
Screenshots (optional)
Anything Else? (optional)
Check list
here is an example commit