diff --git a/README.md b/README.md index 558394fc..855a3610 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This is a web application originally developed for the Preservation Lab at the U ## Prerequisites - a current version of nvm -- Node >= 18.x.x +- Node >= 20.14.0 - Yarn >= 1.22.17 - Ruby 3.3.1 - Rails 6.1.7.7 @@ -26,8 +26,8 @@ CONFIGURE_OPTS="--with-openssl-dir=$(brew --prefix openssl@1.1) --with-opt-dir=$ #### Node Version Management -This project uses nvm (Node Version Manager) to manage Node.js versions. The `.nvmrc` file is configured to use any -version of Node.js 18 to ensure compatibility with the latest features and security updates of that major version. +This project uses nvm (Node Version Manager) to manage Node.js versions. The `.nvmrc` file is configured to use the +latest LTS version of Node, 20.14.0, to ensure compatibility with the latest features and security updates. When running locally, you will need to set the node version with `nvm use` as described below under "Installation". For deployment, the `.nvmrc` file will be used to set the node version and the deployment script will automatically @@ -37,9 +37,9 @@ use the correct version. ```bash git clone github.com/uclibs/treatment_database -bundle install nvm install # Installs the node version listed in .nvmrc nvm use # Directs to the correct node version listed in .nvmrc +bundle install ``` ## Prepare the database.