From 3088b12ceaa49c1e9124c6e962c59df04c7d7d09 Mon Sep 17 00:00:00 2001 From: Jessie Mongeon Date: Fri, 27 Sep 2024 13:21:27 -0500 Subject: [PATCH 1/3] Add info about required node version --- docs/developer-docs/ai/machine-learning-sample.mdx | 2 +- docs/developer-docs/getting-started/deploy/local.mdx | 2 +- docs/developer-docs/getting-started/deploy/mainnet.mdx | 2 +- docs/developer-docs/getting-started/hello-world.mdx | 2 +- .../getting-started/quickstart/react-quickstart.mdx | 2 +- docs/developer-docs/identity/authentication/nfid.mdx | 2 +- .../identity/internet-identity/integrate-internet-identity.mdx | 2 +- .../web-apps/application-frontends/add-stylesheet.mdx | 2 +- .../web-apps/application-frontends/default-frontend.mdx | 2 +- docs/developer-docs/web-apps/application-frontends/webpack.mdx | 2 +- docs/tutorials/developer-journey/level-0/03-dev-env.mdx | 2 +- .../hackathon-prep-course/2-deploying-first-fullstack-dapp.mdx | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/developer-docs/ai/machine-learning-sample.mdx b/docs/developer-docs/ai/machine-learning-sample.mdx index 28d7e8be4e..55f27960eb 100644 --- a/docs/developer-docs/ai/machine-learning-sample.mdx +++ b/docs/developer-docs/ai/machine-learning-sample.mdx @@ -27,7 +27,7 @@ This project is based off of one [found within the Rust Burn examples](https://g - [x] [Download and install Rust](https://www.rust-lang.org/tools/install). -- [x] [Download and install Node.js](https://nodejs.org/en/download). +- [x] [Download and install Node.js](https://nodejs.org/en/download) `16.0.0` or newer. - [x] [Download and install the IC SDK](/docs/current/developer-docs/getting-started/install/). diff --git a/docs/developer-docs/getting-started/deploy/local.mdx b/docs/developer-docs/getting-started/deploy/local.mdx index c3a4856c6f..6f22a35306 100644 --- a/docs/developer-docs/getting-started/deploy/local.mdx +++ b/docs/developer-docs/getting-started/deploy/local.mdx @@ -23,7 +23,7 @@ Before you create your first canister, verify the following: -   [x] You have an internet connection and access to a shell terminal on your local computer. --   [x] You have `Node.js` installed if you want to include the default template files for frontend development in your project. +-   [x] You have `Node.js` `16.0.0` or newer installed if you want to include the default template files for frontend development in your project. -   [x] You have downloaded and installed the IC SDK package as described in the [installing the IC SDK](/docs/current/developer-docs/getting-started/install/) page. diff --git a/docs/developer-docs/getting-started/deploy/mainnet.mdx b/docs/developer-docs/getting-started/deploy/mainnet.mdx index 6d2987f86a..912e761ac0 100644 --- a/docs/developer-docs/getting-started/deploy/mainnet.mdx +++ b/docs/developer-docs/getting-started/deploy/mainnet.mdx @@ -22,7 +22,7 @@ Before you download and install this release of the IC SDK, verify the following - [x] You have an internet connection and access to a shell terminal on your local computer. -- [x] You have `Node.js` installed if you want to access the default frontend for the default project. +- [x] You have `Node.js` `16.0.0` or newer installed if you want to access the default frontend for the default project. - [x] You have ICP tokens or cycles available for you to use. diff --git a/docs/developer-docs/getting-started/hello-world.mdx b/docs/developer-docs/getting-started/hello-world.mdx index e6edafefaa..73f840b8dd 100644 --- a/docs/developer-docs/getting-started/hello-world.mdx +++ b/docs/developer-docs/getting-started/hello-world.mdx @@ -71,7 +71,7 @@ Download and install the latest version of [dfx](install/index.mdx). `dfx` is a sh -ci "$(curl -fsSL https://internetcomputer.org/install.sh)" ``` -### Install [Node.js](https://nodejs.org/en/download) +### Install [Node.js](https://nodejs.org/en/download) `16.0.0` or newer ```bash curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash diff --git a/docs/developer-docs/getting-started/quickstart/react-quickstart.mdx b/docs/developer-docs/getting-started/quickstart/react-quickstart.mdx index ee3273e228..0e0d1bef9d 100644 --- a/docs/developer-docs/getting-started/quickstart/react-quickstart.mdx +++ b/docs/developer-docs/getting-started/quickstart/react-quickstart.mdx @@ -487,7 +487,7 @@ module: { ``` :::caution -Since `dfx` projects rely on Webpack to provide the default frontend configuration, you must have [Node.js](https://nodejs.org/en) installed in your development environment. +Since `dfx` projects rely on Webpack to provide the default frontend configuration, you must have [Node.js](https://nodejs.org/en) `16.0.0` or newer installed in your development environment. ::: Additionally, you can customize the frontend further by adding images, videos, or other React components. You can learn more about customizing the frontend in the [documentation](/docs/current/developer-docs/web-apps/application-frontends/overview). diff --git a/docs/developer-docs/identity/authentication/nfid.mdx b/docs/developer-docs/identity/authentication/nfid.mdx index fcf929b55c..004157a68b 100644 --- a/docs/developer-docs/identity/authentication/nfid.mdx +++ b/docs/developer-docs/identity/authentication/nfid.mdx @@ -24,7 +24,7 @@ NFID also supports signing in with a passkey stored on a mobile device or local Before starting the guide, verify the following: -- [x] You have `Node.js` installed for frontend development and can install packages using `npm install` in your project. For information about installing node for your local operating system and package manager, see the [Node](https://nodejs.org/en/) website. +- [x] You have `Node.js` `16.0.0` or newer installed for frontend development and can install packages using `npm install` in your project. For information about installing node for your local operating system and package manager, see the [Node](https://nodejs.org/en/) website. - [x] You have downloaded and installed the IC SDK package as described in the [download and install](/docs/current/developer-docs/getting-started/install/) page. diff --git a/docs/developer-docs/identity/internet-identity/integrate-internet-identity.mdx b/docs/developer-docs/identity/internet-identity/integrate-internet-identity.mdx index 926902c855..3ceeb18617 100644 --- a/docs/developer-docs/identity/internet-identity/integrate-internet-identity.mdx +++ b/docs/developer-docs/identity/internet-identity/integrate-internet-identity.mdx @@ -22,7 +22,7 @@ This project uses the **pullable** version of the Internet identity canister. A Before you start, verify that you have: - Downloaded and installed [`dfx`](https://github.com/dfinity/sdk/releases/latest) version 0.14.1 or later. -- [Node.js v16+](https://nodejs.org/en). +- [Node.js `16.0.0` or newer](https://nodejs.org/en). ### Step 1: To get started, open a terminal window and create a new project. diff --git a/docs/developer-docs/web-apps/application-frontends/add-stylesheet.mdx b/docs/developer-docs/web-apps/application-frontends/add-stylesheet.mdx index 555a7a3396..253f721793 100644 --- a/docs/developer-docs/web-apps/application-frontends/add-stylesheet.mdx +++ b/docs/developer-docs/web-apps/application-frontends/add-stylesheet.mdx @@ -17,7 +17,7 @@ import { GlossaryTooltip } from "/src/components/Tooltip/GlossaryTooltip"; Before you start, verify that you have: --  [x] `Node.js` installed for frontend development and can install packages using `npm install` in your project. For information about installing Node for your local operating system and package manager, see the [Node](https://nodejs.org/en/) website. +-  [x] `Node.js` `16.0.0` or newer installed for frontend development and can install packages using `npm install` in your project. For information about installing Node for your local operating system and package manager, see the [Node](https://nodejs.org/en/) website. - [x] Downloaded and installed [`dfx`](https://github.com/dfinity/sdk/releases/latest) version `0.17.0` or newer. diff --git a/docs/developer-docs/web-apps/application-frontends/default-frontend.mdx b/docs/developer-docs/web-apps/application-frontends/default-frontend.mdx index 4ba0636f3e..d211e4074f 100644 --- a/docs/developer-docs/web-apps/application-frontends/default-frontend.mdx +++ b/docs/developer-docs/web-apps/application-frontends/default-frontend.mdx @@ -61,7 +61,7 @@ By default, the `index.js` file imports an agent that is located in the `src/dec Before you start, verify that you have: -- [x] Node.js installed for frontend development and can install packages using `npm install` in your project. For information about installing Node for your local operating system and package manager, see the [Node](https://nodejs.org/en/) website. +- [x] Node.js `16.0.0` or newer installed for frontend development and can install packages using `npm install` in your project. For information about installing Node for your local operating system and package manager, see the [Node](https://nodejs.org/en/) website. - [x] Downloaded and installed [`dfx`](https://github.com/dfinity/sdk/releases/latest) version `0.17.0` or newer. diff --git a/docs/developer-docs/web-apps/application-frontends/webpack.mdx b/docs/developer-docs/web-apps/application-frontends/webpack.mdx index 76e76328e1..1db848f87d 100644 --- a/docs/developer-docs/web-apps/application-frontends/webpack.mdx +++ b/docs/developer-docs/web-apps/application-frontends/webpack.mdx @@ -39,7 +39,7 @@ DFX_NETWORK=ic NODE_ENV=production HELLO_CANISTER_ID=rrkah... npm run build ### Ensuring Node.js is available in a project -Because projects rely on webpack to provide the framework for the default frontend, you must have `Node.js` installed in +Because projects rely on webpack to provide the framework for the default frontend, you must have `Node.js` `16.0.0` or newer installed in your development environment and accessible in the project directory. - If you want to develop your project without using the default webpack configuration and canister aliases, you can remove the `frontend` canister from the `dfx.json` file or build your project using a specific canister name. For example, you can choose to build only the `hello` program's backend canister without building the frontend assets by running the following command: diff --git a/docs/tutorials/developer-journey/level-0/03-dev-env.mdx b/docs/tutorials/developer-journey/level-0/03-dev-env.mdx index 54936a0710..25d0ffb897 100644 --- a/docs/tutorials/developer-journey/level-0/03-dev-env.mdx +++ b/docs/tutorials/developer-journey/level-0/03-dev-env.mdx @@ -89,7 +89,7 @@ Many of the DFINITY public repositories are hosted on Github, such as our `examp ### Download and install Node.js -Download and install [node.js](https://nodejs.org/en). +Download and install [Node.js](https://nodejs.org/en) `16.0.0` or newer. #### Why does this matter? diff --git a/docs/tutorials/hackathon-prep-course/2-deploying-first-fullstack-dapp.mdx b/docs/tutorials/hackathon-prep-course/2-deploying-first-fullstack-dapp.mdx index 0e75d6f98d..7093e569a9 100644 --- a/docs/tutorials/hackathon-prep-course/2-deploying-first-fullstack-dapp.mdx +++ b/docs/tutorials/hackathon-prep-course/2-deploying-first-fullstack-dapp.mdx @@ -176,7 +176,7 @@ Before you can deploy your first dapp on ICP, you will need to set up your devel - [x] Download and install [git](https://git-scm.com/downloads). -- [x] Download and install [Node.js](https://nodejs.org/en). +- [x] Download and install [Node.js](https://nodejs.org/en) `16.0.0` or newer. Then, to download the template project, first create a new directory, then download the project template using the commands: From 2afaf91c77f848552433d5e9156b6339c0a2c5b9 Mon Sep 17 00:00:00 2001 From: Jessie Mongeon Date: Fri, 27 Sep 2024 14:30:08 -0500 Subject: [PATCH 2/3] fix --- blog/news-and-updates/2024-07-24-update.mdx | 2 +- docs/developer-docs/ai/ai-on-chain.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/blog/news-and-updates/2024-07-24-update.mdx b/blog/news-and-updates/2024-07-24-update.mdx index 9c70db95bf..e3a7a9ced5 100644 --- a/blog/news-and-updates/2024-07-24-update.mdx +++ b/blog/news-and-updates/2024-07-24-update.mdx @@ -62,7 +62,7 @@ This week, the agent documentation saw some significant revisions, specifically - [JavaScript agent](/docs/current/developer-docs/developer-tools/off-chain/agents/javascript-agent) -- [NodeJS](/docs/current/developer-docs/developer-tools/off-chain/agents/nodejs) +- [Node.JS](/docs/current/developer-docs/developer-tools/off-chain/agents/nodejs) - [Rust agent](/docs/current/developer-docs/developer-tools/off-chain/agents/rust-agent) diff --git a/docs/developer-docs/ai/ai-on-chain.mdx b/docs/developer-docs/ai/ai-on-chain.mdx index 5c0e0c26dc..7b445007e0 100644 --- a/docs/developer-docs/ai/ai-on-chain.mdx +++ b/docs/developer-docs/ai/ai-on-chain.mdx @@ -102,7 +102,7 @@ Download MobileNet v2-7 to `src/backend/assets/mobilenetv2-7.onnx` by running th ./download_model.sh ``` -Install NodeJS dependencies for the frontend: +Install Node.JS dependencies for the frontend: ``` npm install From d567cba487562aaf5c0f276a4185789c47c81eba Mon Sep 17 00:00:00 2001 From: Jessie Mongeon Date: Fri, 27 Sep 2024 15:57:03 -0500 Subject: [PATCH 3/3] fix typo --- blog/news-and-updates/2024-07-24-update.mdx | 2 +- docs/developer-docs/ai/ai-on-chain.mdx | 2 +- .../developer-tools/off-chain/agents/javascript-agent.mdx | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/blog/news-and-updates/2024-07-24-update.mdx b/blog/news-and-updates/2024-07-24-update.mdx index e3a7a9ced5..3924e38a32 100644 --- a/blog/news-and-updates/2024-07-24-update.mdx +++ b/blog/news-and-updates/2024-07-24-update.mdx @@ -62,7 +62,7 @@ This week, the agent documentation saw some significant revisions, specifically - [JavaScript agent](/docs/current/developer-docs/developer-tools/off-chain/agents/javascript-agent) -- [Node.JS](/docs/current/developer-docs/developer-tools/off-chain/agents/nodejs) +- [Node.js](/docs/current/developer-docs/developer-tools/off-chain/agents/nodejs) - [Rust agent](/docs/current/developer-docs/developer-tools/off-chain/agents/rust-agent) diff --git a/docs/developer-docs/ai/ai-on-chain.mdx b/docs/developer-docs/ai/ai-on-chain.mdx index 7b445007e0..a959ce2628 100644 --- a/docs/developer-docs/ai/ai-on-chain.mdx +++ b/docs/developer-docs/ai/ai-on-chain.mdx @@ -102,7 +102,7 @@ Download MobileNet v2-7 to `src/backend/assets/mobilenetv2-7.onnx` by running th ./download_model.sh ``` -Install Node.JS dependencies for the frontend: +Install Node.js dependencies for the frontend: ``` npm install diff --git a/docs/developer-docs/developer-tools/off-chain/agents/javascript-agent.mdx b/docs/developer-docs/developer-tools/off-chain/agents/javascript-agent.mdx index 6283c99470..fdce0bb14c 100644 --- a/docs/developer-docs/developer-tools/off-chain/agents/javascript-agent.mdx +++ b/docs/developer-docs/developer-tools/off-chain/agents/javascript-agent.mdx @@ -20,7 +20,7 @@ Calls made through the agent are intended to be structured through an actor and To get started with `agent-js`, it is recommended that your development environment include: - [x] IC SDK for canister creation and management. -- [x] Node JS (12, 14, or 16). +- [x] Node.js (12, 14, or 16). - [x] A canister you want to experiment with.   - Suggestions:     - `dfx new` default project.