alexandrebarachant / BrainWaves

An easy-to-use platform for EEG experimentation in the classroom

BrainWaves

An easy-to-use platform for EEG experimentation in the classroom

Install

• Note: requires a node version >= 7 and an npm version >= 4.
• If you have installation or compilation issues with this project, please see our debugging guide

1. First, clone the repo via git:

git clone https://github.com/makebrainwaves/BrainWaves.git

2. For OSX, you may need to update your .bash_profile to include the path for your compiler (nothing terribly scary):

i.) First, find its location

which gcc

ii.) Then add this path to your .bash_profile

export PATH="/usr/bin:$PATH"

3. And then install dependencies

$ cd BrainWaves
$ npm install

Link jspsych-react

1. Go to https://github.com/makebrainwaves/jspsych-react and clone that library.

2. Link it to your npm by running npm link in the jspsych-react folder. Note, this may require you to use sudo since this is creating symlink into your usr/local/bin/lib.

3. Go back to BrainWaves folder and run npm link jspsych-react

Create a conda environment and link it to jupyter

BrainWaves needs an Anaconda environment called "brainwaves" with the right dependencies to run analysis.

To do this, first create a new conda env called brainwaves: conda env create -f environment.yml

Then, set up a new jupyter kernel to use this environment: python -m ipykernel install --user --name brainwaves --display-name "brainwaves"

Run

Start the app in the dev environment. This starts the renderer process in hot-module-replacement mode and starts a webpack dev server that sends hot updates to the renderer process:

$ npm run dev

Alternatively, you can run the renderer and main processes separately. This way, you can restart one process without waiting for the other. Run these two commands simultaneously in different console tabs:

$ npm run start-renderer-dev
$ npm run start-main-dev

Packaging

To package apps for the local platform:

$ npm run package

To package apps for all platforms:

First, refer to Multi Platform Build for dependencies.

Then,

$ npm run package-all

To package apps with options:

$ npm run package -- --[option]

To run End-to-End Test

$ npm run build
$ npm run test-e2e

💡 You can debug your production build with devtools by simply setting the DEBUG_PROD env variable:

DEBUG_PROD=true npm run package

How to add modules to the project

You will need to add other modules to this boilerplate, depending on the requirements of your project. For example, you may want to add node-postgres to communicate with PostgreSQL database, or material-ui to reuse react UI components.

⚠️ Please read the following section before installing any dependencies ⚠️

Module Structure

This boilerplate uses a two package.json structure. This means, you will have two package.json files.

1. ./package.json in the root of your project
2. ./app/package.json inside app folder

Which package.json file to use

Rule of thumb is: all modules go into ./package.json except native modules. Native modules go into ./app/package.json.

1. If the module is native to a platform (like node-postgres), it should be listed under dependencies in ./app/package.json
2. If a module is imported by another module, include it in dependencies in ./package.json. See this ESLint rule. Examples of such modules are material-ui, redux-form, and moment.
3. Otherwise, modules used for building, testing and debugging should be included in devDependencies in ./package.json.

Further Readings

See the wiki page, Module Structure — Two package.json Structure to understand what is native module, the rationale behind two package.json structure and more.

For an example app that uses this boilerplate and packages native dependencies, see erb-sqlite-example.

Static Type Checking

This project comes with Flow support out of the box! You can annotate your code with types, get Flow errors as ESLint errors, and get type errors during runtime during development. Types are completely optional.

Dispatching redux actions from main process

See #118 and #108

How to keep your project updated with the boilerplate

If your application is a fork from this repo, you can add this repo to another git remote:

git remote add upstream https://github.com/chentsulin/electron-react-boilerplate.git

Then, use git to merge some latest commits:

git pull upstream master