Skip to content

Commit c453b36

Browse files
committed
docs: add Node.js and pnpm prerequisites to README and create .nvmrc for Node.js version 22.13.0
1 parent 088465c commit c453b36

2 files changed

Lines changed: 21 additions & 0 deletions

File tree

template/.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
22.13.0

template/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
# [Documentation](https://ship.paralect.com/docs/introduction)
22

3+
## Prerequisites
4+
5+
This project requires specific versions of Node.js and pnpm. Please check the `engines` and `packageManager` fields in `package.json` for the required versions.
6+
7+
### Node.js
8+
9+
If you're using [nvm](https://github.com/nvm-sh/nvm), you can automatically switch to the correct Node.js version by running:
10+
```sh
11+
nvm use
12+
```
13+
14+
This will read the version from the `.nvmrc` file and switch to it automatically.
15+
16+
### pnpm
17+
18+
If you have [Corepack](https://nodejs.org/api/corepack.html) enabled (included with Node.js 16.10+), pnpm will automatically use the version specified in the `packageManager` field of `package.json`. You can enable Corepack by running:
19+
```sh
20+
corepack enable
21+
```
22+
323
## Starting Application with Turborepo 🚀
424

525
To run the infrastructure and all services -- just run:

0 commit comments

Comments
 (0)