ruxailab / web-eye-tracker

MIT License
3 stars 17 forks source link

πŸ‘οΈ Eye Lab: Gaze Tracker API

Eye Lab is an open source tool to create eye tracking usability tests. It started as a final undergraduation work for Computer Engineering of student Karine Pistili that created the first prototype. The idea is to evolve it to a more complete and useful tool with the help of the community.

The current version of the software allows users to create their usability sessions of an website, recording the webcam, screen and mouse movements and use this information to find out where the user has been looking into the screen by using heatmaps.

πŸ‘©β€πŸ’» Setting up project locally

The project consists of two parts, this repository contains the backend of the application and the frontend can be found here. Install it as well.

Prerequisites

1. Create virtual environment

Before installing all dependencies and starting your Flask Server, it is better to create a python virtual environment. You can use the venv package

python -m venv /path/to/new/virtual/environment

Then activate your env. On windows for example you can activate with the script:

name-of-event/Scripts/activate

2. Install dependencies

Install all dependencies listed on the requirements.txt with:

pip install -r requirements.txt

3. Run the Flask API

flask run

πŸ§‘β€πŸ€β€πŸ§‘ Contributing

Anyone is free to contribute to this project. Just do a pull request with your code and if it is all good we will accept it. You can also help us look for bugs, if you find anything create and issue.

πŸ“ƒ License

This software is under the MIT License.

Copyright 2021 Uramaki Lab