Elephant Vending Machine

OSU CSE 5911 Capstone Project: Elephant Vending Machine in coordination with Cincinnati Zoo. Designed to facilitate automated behavioral psychology experiments.

Dependencies

For this project to run successfully, you must have installed:

• Node >= 8.10
• npm >= 5.6

Starting the user interface

NOTE: You will need to set your local environment variables if not connected to the actual backend running on the Raspberry Pi attached to the real hardware. See documentation here for reference.

1. Navigate to the root directory of this project
2. Run npm start

Viewing Documentation

1. Navigate to the root directory of this project
2. Run npm run docs
3. Open the generated page in docs/index.html in a browser
   • Up to date documentation can be found here.

Running linting

1. Navigate to the root directory of this project
2. Run npm run lint
   • Note: Code is automatically formatted with Prettier on each commit. You can use npm run format to run the formatter manually

Running tests

1. Navigate to the root directory of this project
2. Run npm test
   • A coverage report can be viewed with npm run test:coverage

Running in production

1. Clone this repo to the Pi
2. Navigate to the cloned directory
3. Install docker and docker-compose
4. Run docker-compose up --build to start the container
   • This will ensure the app automatically restarts in case of errors or reboots.
   • To stop the containers you can use ctrl-c or docker-compose down