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

Update developers/configuration docs

Browse Source
This commit is contained in:
bjoluc 2021-10-01 15:25:26 +02:00
parent 29e285694b
commit bb89baef40
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/developers/configuration.md
View File

@ -18,23 +18,26 @@ If you are bound to Node.js v14, make sure to install NPM v7 manually (via `npm
Clone either the jsPsych repository or the jspsych-contrib repository by running
```sh
git clone https://github.com/jspsych/jsPsych.git
git clone https://github.com/jspsych/jsPsych.git && cd jsPsych
```
or
```sh
git clone https://github.com/jspsych/jspsych-contrib.git
git clone https://github.com/jspsych/jspsych-contrib.git && cd jspsych-contrib
```
in a terminal.
Then navigate into the repository's directory via `cd jsPsych` or `cs jspsych-contrib`.
Finally, 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.
Afterwards, it will run the build chain for all packages in the jsPsych repository.
!!! attention
It is important that `npm install` is only run in the root directory of the repository (due to the NPM workspaces feature).
If you accidentally ran `npm install` anywhere else, remove the `node_modules` directory and the `package-lock.json` file that were created at that location and run `npm install` in the root directory again.
!!! info
The build step will take a few minutes.
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.
If you would like to use that time efficiently, consider reading the following two sections to know what's happening.
## Repository structure
@ -92,4 +95,4 @@ Tests for the core jsPsych library are located in `/packages/jspsych/tests`.
Tests for plugins and extensions are located in the `/src` folder of the corresponding package. Test files for plugins and extensions are named `index.spec.ts`.
There are helper functions for testing in `/packages/jspsych/tests/utils.ts`. We recommend looking at other test files to observe conventions for testing.
There are helper functions for testing in `/packages/jspsych/tests/utils.ts`. We recommend looking at other test files to observe conventions for testing.