Skip to content

Update installation.md #3447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 10, 2025
Merged

Update installation.md #3447

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a51f71
Update installation.md
SonyaCode Apr 10, 2025
bb936e0
Update Numbering Typo
raclim Apr 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update Numbering Typo
  • Loading branch information
@raclim
raclim authored Apr 10, 2025
commit bb936e0187e7c4beaf517be9053502242a4a6024
28 changes: 14 additions & 14 deletions contributor_docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]` 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 [email protected]` 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

Expand Down