diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 00000000..9a2a0e21 --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +v20 diff --git a/README-project.md b/README-project.md index 4dd11c60..becde97d 100644 --- a/README-project.md +++ b/README-project.md @@ -7,12 +7,30 @@ Mobile App ## Requirements - [React Native dev environment](https://reactnative.dev/docs/environment-setup) -- [Node.js LTS release](https://nodejs.org/en/) +- [Node.js](https://nodejs.org/en/) (version specified in `.nvmrc`) - [Git](https://git-scm.com/) - [Watchman](https://facebook.github.io/watchman/docs/install#buildinstall), required only for macOS or Linux users - [Pnpm](https://pnpm.io/installation) - [Cursor](https://www.cursor.com/) or [VS Code Editor](https://code.visualstudio.com/download) ⚠️ Make sure to install all recommended extension from `.vscode/extensions.json` +### Node.js Version Management + +This project uses a `.nvmrc` file to specify the recommended Node.js version. We recommend using a Node.js version manager such as [fnm](https://github.com/Schniz/fnm) or [nvm](https://github.com/nvm-sh/nvm) to ensure you're using the correct version: + +**With fnm:** +```sh +fnm install +fnm use +``` + +**With nvm:** +```sh +nvm install +nvm use +``` + +The version manager will automatically read the `.nvmrc` file and switch to the correct Node.js version. + ## 👋 Quick start Clone the repo to your machine and install deps : diff --git a/README.md b/README.md index b1d34c50..a93fddb3 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,24 @@ This repository is a fork of [Obytes Starter](https://github.com/obytes/react-native-template-obytes), which provides a solid foundation. We periodically sync with the original repo to stay up-to-date with their improvements, while making our own adjustments and optimizations to streamline our setup process. +## 📋 Node.js Version Management + +This template specifies a recommended Node.js version in the `.nvmrc` file. We recommend using a Node.js version manager such as [fnm](https://github.com/Schniz/fnm) or [nvm](https://github.com/nvm-sh/nvm) to ensure you're using the correct version. + +**With fnm:** +```sh +fnm install +fnm use +``` + +**With nvm:** +```sh +nvm install +nvm use +``` + +The version manager will automatically read the `.nvmrc` file and switch to the correct Node.js version for this project. + # Overview As a team of experienced developers at Rootstrap, we have spent years building high-quality React Native applications. Our initial starter kit was designed for React Native CLI apps. However, with the strong recommendation to work with Expo since React Native 0.75, we recognized the need to adapt quickly and leverage the best tools available.