HoshinoKoji/jsPsych
1
0
Fork 0
mirror of https://github.com/jspsych/jsPsych.git synced 2025-05-10 11:10:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #3178 from jspsych/docs-update-setup-instructions

Browse Source 
Update dev environment configuration docs

(rebased-with-history from commit d33176a5f3)
This commit is contained in:
bjoluc 2023-11-15 20:31:50 +01:00
commit 4eba29d00d
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/developers/configuration.md
View File

@ -9,7 +9,7 @@ In order to work on code in the jsPsych or the jspsych-contrib repository, it is
### Install Node.js ### 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 ### Clone the repository and install the dependencies
@ -30,6 +30,11 @@ in a terminal.
Then run `npm install`. 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. 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 !!! 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. 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. This step may take a few minutes.