Sensory Survey 3D

survey3dexample.mp4

Sensory Survey 3D is a JavaScript and Python-based framework for collecting sensory information from participants in brain-computer interface (BCI) studies. With this app, participants can mark where percepts are felt on a 3D representation of their body, allowing for more precision in collected data.

Installation

Backend

The backend requires a Python 3.12 installation.

In the backend folder, there is a requirements.txt file. Navigate to this folder with your command line, and use the following command:

pip install -r requirements.txt

Frontend

The frontend requires a Node.js installation.

In the frontend folder, there is a package-lock.json file. Navigate to this folder with your command line, and use the following command:

npm i

Running

Backend

In the backend folder, run the following command:

uvicorn main:app --reload

By default, this will open the backend to 127.0.0.1:8000. If you would like to change this, you may use the --host and --port options to set the IP and port for the backend. If you do so: you must change the socketURL variable in common.json to match your settings.

Frontend

In the frontend folder, run the following command:

npx vite

By default, this will open the frontend to localhost. You may use the --host flag to change the IP.