README.md

EEG Studio

EEG Studio is a web-based application which facilitates labelling electroencephalography (EEG) record for later use. To that end, it provides handy tools so that you can effortlessly zoom, pan, and mark on-set ranges on any EEG plots.

Table of Contents

• Developing
• Documentation
• License

Developing

Prerequisites

Docker

• Docker Community Edition 17.09.0-ce or higher
• Docker Compose 1.17.0 or higher

Frontend

• Node.js 8.9.1 or higher
• Yarn 1.3.2 or higher (as a npm replacement)

Quickstart

1. Clone this repo using git clone git@github.com:pirsquareff/eeg-studio.git
2. Run docker-compose up --build within project's root directory. This will start backend service at localhost:3002.
3. Also run yarn within project's root directory to start frontend app which will be available at localhost:3000.

Documentation

React Boilerplate

• The Hitchhikers Guide to react-boilerplate: An introduction for newcomers to this boilerplate.
• Overview: A short overview of the included tools
• Commands: Getting the most out of this boilerplate
• Testing: How to work with the built-in test harness
• Styling: How to work with the CSS tooling
• Your app: Supercharging your app with Routing, Redux, simple asynchronicity helpers, etc.
• Troubleshooting: Solutions to common problems faced by developers.

License

This project is licensed under the MIT license, Copyright (c) 2017 Parinthorn Saithong.
For more information see LICENSE.md.

---

_{Created by Parinthorn Saithong and maintained with ❤️.}