Skip to content

Conversation

@ups216
Copy link
Member

@ups216 ups216 commented Jun 5, 2025

…t for easier environment configuration
This pull request introduces Node Version Manager (nvm) to manage Node.js versions across the project and streamlines the setup process with a new setup script. It also updates the documentation and adds safeguards to ensure the correct Node.js version is used when installing dependencies.

Node.js Version Management:

  • Added .nvmrc files to the root, client, and server directories to specify the required Node.js version (22.16.0).

Documentation Updates:

  • Updated README.md to include a new "Prerequisites" section explaining the use of nvm, instructions for installing it, and guidance on project setup using the .nvmrc file or the new setup script.

Setup Automation:

  • Introduced a setup.sh script to automate the setup process, including sourcing nvm, ensuring the correct Node.js version is used, and installing dependencies.

Dependency Installation Safeguards:

  • Added a preinstall script in package.json to remind users to run nvm use before installing dependencies.

@ups216 ups216 requested a review from Copilot June 5, 2025 03:01
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR standardizes Node.js version management with nvm, provides an automated setup script, and updates documentation to streamline onboarding.

  • Added root, client, and server .nvmrc files locking Node.js to v22.16.0
  • Introduced setup.sh to load nvm, use/install the correct Node version, and install dependencies
  • Updated README.md with nvm prerequisites and quick/manual setup instructions; added a preinstall reminder in package.json

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
setup.sh New bootstrap script to source nvm, switch/install Node, and run npm install
package.json Added preinstall echo reminder to prompt nvm use
.nvmrc Root file specifying Node.js v22.16.0
client/.nvmrc Client workspace Node version config
server/.nvmrc Server workspace Node version config
README.md Documented nvm install, reload shell, and quick/manual project setup steps
Comments suppressed due to low confidence (3)

setup.sh:17

  • [nitpick] Recommend mentioning sourcing ~/.zshrc (or other shell profiles) for users on zsh or other shells when reloading their shell configuration.
echo "   source ~/.bashrc"

package.json:11

  • The preinstall script currently only echoes a reminder; consider enforcing the Node.js version check here (e.g., exit if node --version does not match .nvmrc) to prevent incorrect dependency installs.
"preinstall": "echo 'Make sure to run \"nvm use\" before installing dependencies'"

README.md:142

  • [nitpick] Consider noting that setup.sh needs execute permissions (chmod +x setup.sh) or instruct users to run it with bash ./setup.sh.
./setup.sh

@ups216 ups216 merged commit 467e913 into main Jun 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants