-
Notifications
You must be signed in to change notification settings - Fork 63
Added instructions for installing Node #2040
Conversation
README.md
Outdated
Before installing pnpm, make sure to switch to node versin 16: | ||
|
||
```bash | ||
node --version | ||
``` | ||
|
||
If not 16, install node version 16 using: | ||
|
||
```bash | ||
nvm isntall 16 | ||
nvm use 16 | ||
``` | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As described in the issue, we use volta
to pin the Node version that we use for the project.
These instructions should read something like:
- Install
node
using Volta:volta install node@16
- Install
pnpm
using Volta:volta install pnpm
- Run
volta run pnpm dev
These will be simplified soon once Volta fully supports pnpm
, which should happen with the next Volta release: volta-cli/volta#737 (comment)
At that point the instructions can be reduced to simply volta run pnpm dev
.
Changed NODE installation instructions as per changes requested.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great, except for one change I suggested inline.
README.md
Outdated
@@ -33,7 +39,7 @@ Run the following commands in order to have the code up and running on your mach | |||
```bash | |||
# Builds and serves assets with hot-reload | |||
# Automatically invokes pnpm install and pnpm i18n | |||
pnpm dev | |||
Run volta run pnpm dev |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Run volta run pnpm dev | |
volta run pnpm dev |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your contribution, @rajdeepdas2000 !
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These instructions look good. I can't wait until pnpm is officially supported to make this simpler. Volta automaticaly symlinks the correct node version, but it only does its check to create the correct symlink the first time node
or npm
is evoked in a directory. So if someone has volta installed, clones the frontend, and runs a command likenode -v
in the repo root, at that point volta will automatically install and symlink node v16.15.0
before evoking the command.
Once pnpm support is official, running pnpm dev
will be sufficient to install and link the correct node version. At that time we can remove these instructions.
The required changes were made
Fixes
Fixes #2038 by @sarayourfriend
Description
Added instructions for installing volta, node and pnpm
Testing Instructions
Checklist
Update index.md
).main
) or a parent feature branch.Developer Certificate of Origin
Developer Certificate of Origin