From 9a51f7157f044e545499af084a235a0ec5100f06 Mon Sep 17 00:00:00 2001 From: SonyaCode <99513449+SonyaCode@users.noreply.github.com> Date: Thu, 10 Apr 2025 18:21:09 -0400 Subject: [PATCH 1/2] Update installation.md --- contributor_docs/installation.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/contributor_docs/installation.md b/contributor_docs/installation.md index b461b075d9..8dc2e4e3b8 100644 --- a/contributor_docs/installation.md +++ b/contributor_docs/installation.md @@ -6,27 +6,27 @@ Follow these instructions to set up your development environment, which you need _Note_: The installation steps assume you are using a Unix-like shell. If you are using Windows, you will need to use `copy` instead of `cp`. -1. Install Node.js. The recommended way is to Node through [nvm](https://github.com/nvm-sh/nvm). You can also install [node.js](https://nodejs.org/download/release/v16.14.2/) version 16.14.2 directly from the Node.js website. -2. [Fork](https://help.github.com/articles/fork-a-repo) the [p5.js Web Editor repository](https://github.com/processing/p5.js-web-editor) into your own GitHub account. -3. [Clone](https://help.github.com/articles/cloning-a-repository/) your new fork of the repository from GitHub onto your local computer. +1. Install Node.js. The recommended way is to Node through [nvm](https://github.com/nvm-sh/nvm). You can also install [node.js](https://nodejs.org/download/release/v16.14.2/) version 16.14.2 directly from the Node.js website. To check if you already have Node installed on your computer, run `$ node -v`. +3. [Fork](https://help.github.com/articles/fork-a-repo) the [p5.js Web Editor repository](https://github.com/processing/p5.js-web-editor) into your own GitHub account. +4. [Clone](https://help.github.com/articles/cloning-a-repository/) your new fork of the repository from GitHub onto your local computer. ``` $ git clone https://github.com/YOUR_USERNAME/p5.js-web-editor.git ``` -4. If you are using nvm, run `$ nvm use 16.14.2` to set your Node version to 16.14.2 -5. Ensure your npm version is set to 8.5.0. If it isn't, run `npm install -g npm@8.5.0` to install it. -6. Navigate into the project folder and install all its necessary dependencies with npm. +5. If you are using nvm, run `$ nvm use 16.14.2` to set your Node version to 16.14.2 +6. Ensure your npm version is set to 8.5.0. If it isn't, run `npm install -g npm@8.5.0` to install it. +7. Navigate into the project folder and install all its necessary dependencies with npm. ``` $ cd p5.js-web-editor $ npm install ``` -7. Install MongoDB and make sure it is running +8. Install MongoDB and make sure it is running * For Mac OSX with [homebrew](http://brew.sh/): `brew tap mongodb/brew` then `brew install mongodb-community` and finally start the server with `brew services start mongodb-community` or you can visit the installation guide here [Installation Guide For MacOS](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-os-x/) * For Windows and Linux: [MongoDB Installation](https://docs.mongodb.com/manual/installation/) -8. `$ cp .env.example .env` -9. (Optional) Update `.env` with necessary keys to enable certain app behaviors, i.e. add Github ID and Github Secret if you want to be able to log in with Github. +9. `$ cp .env.example .env` +10. (Optional) Update `.env` with necessary keys to enable certain app behaviors, i.e. add Github ID and Github Secret if you want to be able to log in with Github. * See the [GitHub API Configuration](#github-api-configuration) section for information on how to authenticate with Github. * See the [S3 Bucket Configuration](#s3-bucket-configuration) section for information on how to set up an S3 bucket 11. Run `$ npm run fetch-examples` to download the example sketches into a user called 'p5'. Note that you need to configure your GitHub Credentials, which you can do by following the [Github API Configuration](#github-api-configuration) section. From bb936e0187e7c4beaf517be9053502242a4a6024 Mon Sep 17 00:00:00 2001 From: raclim <43053081+raclim@users.noreply.github.com> Date: Thu, 10 Apr 2025 18:32:37 -0400 Subject: [PATCH 2/2] Update Numbering Typo --- contributor_docs/installation.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/contributor_docs/installation.md b/contributor_docs/installation.md index 8dc2e4e3b8..a418cba5da 100644 --- a/contributor_docs/installation.md +++ b/contributor_docs/installation.md @@ -7,34 +7,34 @@ Follow these instructions to set up your development environment, which you need _Note_: The installation steps assume you are using a Unix-like shell. If you are using Windows, you will need to use `copy` instead of `cp`. 1. Install Node.js. The recommended way is to Node through [nvm](https://github.com/nvm-sh/nvm). You can also install [node.js](https://nodejs.org/download/release/v16.14.2/) version 16.14.2 directly from the Node.js website. To check if you already have Node installed on your computer, run `$ node -v`. -3. [Fork](https://help.github.com/articles/fork-a-repo) the [p5.js Web Editor repository](https://github.com/processing/p5.js-web-editor) into your own GitHub account. -4. [Clone](https://help.github.com/articles/cloning-a-repository/) your new fork of the repository from GitHub onto your local computer. +2. [Fork](https://help.github.com/articles/fork-a-repo) the [p5.js Web Editor repository](https://github.com/processing/p5.js-web-editor) into your own GitHub account. +3. [Clone](https://help.github.com/articles/cloning-a-repository/) your new fork of the repository from GitHub onto your local computer. ``` $ git clone https://github.com/YOUR_USERNAME/p5.js-web-editor.git ``` -5. If you are using nvm, run `$ nvm use 16.14.2` to set your Node version to 16.14.2 -6. Ensure your npm version is set to 8.5.0. If it isn't, run `npm install -g npm@8.5.0` to install it. -7. Navigate into the project folder and install all its necessary dependencies with npm. +4. If you are using nvm, run `$ nvm use 16.14.2` to set your Node version to 16.14.2 +5. Ensure your npm version is set to 8.5.0. If it isn't, run `npm install -g npm@8.5.0` to install it. +6. Navigate into the project folder and install all its necessary dependencies with npm. ``` $ cd p5.js-web-editor $ npm install ``` -8. Install MongoDB and make sure it is running +7. Install MongoDB and make sure it is running * For Mac OSX with [homebrew](http://brew.sh/): `brew tap mongodb/brew` then `brew install mongodb-community` and finally start the server with `brew services start mongodb-community` or you can visit the installation guide here [Installation Guide For MacOS](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-os-x/) * For Windows and Linux: [MongoDB Installation](https://docs.mongodb.com/manual/installation/) -9. `$ cp .env.example .env` -10. (Optional) Update `.env` with necessary keys to enable certain app behaviors, i.e. add Github ID and Github Secret if you want to be able to log in with Github. +8. `$ cp .env.example .env` +9. (Optional) Update `.env` with necessary keys to enable certain app behaviors, i.e. add Github ID and Github Secret if you want to be able to log in with Github. * See the [GitHub API Configuration](#github-api-configuration) section for information on how to authenticate with Github. * See the [S3 Bucket Configuration](#s3-bucket-configuration) section for information on how to set up an S3 bucket -11. Run `$ npm run fetch-examples` to download the example sketches into a user called 'p5'. Note that you need to configure your GitHub Credentials, which you can do by following the [Github API Configuration](#github-api-configuration) section. -12. Enable Prettier in your text editor by following [this guide](https://prettier.io/docs/en/editors.html). -13. `$ npm start` -14. Navigate to [http://localhost:8000](http://localhost:8000) in your browser -15. Install the [React Developer Tools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en) -16. Open and close the Redux DevTools using `ctrl+h`, and move them with `ctrl+w` +10. Run `$ npm run fetch-examples` to download the example sketches into a user called 'p5'. Note that you need to configure your GitHub Credentials, which you can do by following the [Github API Configuration](#github-api-configuration) section. +11. Enable Prettier in your text editor by following [this guide](https://prettier.io/docs/en/editors.html). +12. `$ npm start` +13. Navigate to [http://localhost:8000](http://localhost:8000) in your browser +14. Install the [React Developer Tools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en) +15. Open and close the Redux DevTools using `ctrl+h`, and move them with `ctrl+w` ## Docker Installation