Skip to content

Commit

Permalink
Merge pull request #3178 from jspsych/docs-update-setup-instructions
Browse files Browse the repository at this point in the history
Update dev environment configuration docs

(rebased-with-history from commit d33176a)
  • Loading branch information
bjoluc committed Jun 7, 2024
2 parents 9042e85 + d33176a commit 4eba29d
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/developers/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ In order to work on code in the jsPsych or the jspsych-contrib repository, it is

### Install Node.js

The jsPsych development setup requires [Node.js](https://nodejs.org/en/) >= v18 to be installed on your machine.
The jsPsych development setup requires a [Node.js LTS version](https://nodejs.org/en/download/) to be installed on your machine.

### Clone the repository and install the dependencies

Expand All @@ -30,6 +30,11 @@ in a terminal.
Then run `npm install`.
This will create a `node_modules` directory and install all the dependencies into it that are required to build and test jsPsych.

!!! info
The jsPsych (-contrib) repositories depend on the `canvas` package which comes with pre-built binaries.
On systems for which no pre-built binaries are available, `npm install` will try to build the binaries from scratch, sometimes failing with an error message mentioning the `canvas` package.
If you are facing such installation issues, please follow the [installation instructions](https://github.com/Automattic/node-canvas/wiki#installation-guides) of the `canvas` package and run `npm install` again afterwards.

!!! info
If you are running `npm install` in the core jsPsych repository, this will also execute the build chain for all packages in the jsPsych repository.
This step may take a few minutes.
Expand Down

0 comments on commit 4eba29d

Please sign in to comment.