FairRecKit App

The FairRecKitApp is a web-based tool intended to aid in the performing and analysing of recommender system computations. It utilises a custom library called FairRecKitLib to perform its computations.

This software has been developed by students within the Software Project course of the bachelor program Computer Science at Utrecht University, commissioned by Christine Bauer.

Development team:
Lennard Chung, Aleksej Cornelissen, Isabelle van Driessel, Diede van der Hoorn, Yme de Jong, Lan Le, Sanaz Najiyan Tabriz, Roderick Spaans, Casper Thijsen, Robert Verbeeten, Vos Wesseling, Fern Wieland

© Copyright Utrecht University (Department of Information and Computing Sciences)

If you use FairRecKit in research, please cite:

Christine Bauer, Lennard Chung, Aleksej Cornelissen, Isabelle van Driessel, Diede van der Hoorn, Yme de Jong, Lan Le, Sanaz Najiyan Tabriz, Roderick Spaans, Casper Thijsen, Robert Verbeeten, Vos Wesseling, & Fern Wieland (2023). FairRecKit: A Web-based analysis software for recommender evaluations. Proceedings of the 8th ACM SIGIR Conference on Human Information Interaction and Retrieval (CHIIR 2023), Austin, TX, USA, 19–23 March, pp 438–443. DOI: 10.1145/3576840.3578274

Running the client & server

• Install Node.js first and run npm install in the client directory to install the needed packages.
• On Windows: Either click the run.bat file in the app directory, or run run in cmd.
• On Unix systems: Run the run.sh file (located in the app directory) in the terminal.

This runs the app in the development mode.
Open http://localhost:3000 to view the client in your browser.
Open http://localhost:5001 for the server.

The page will reload when you make changes.
You can also see any lint errors in the console.

Running the client separately

• Run npm i in the client directory to install the needed packages.
• On Windows: Either click the run-client.bat file in the client directory, or run run-client in cmd.
• On Unix systems: Run the run-client.sh file (located in the client directory) in the terminal.
• Alternatively: Run npm run dev in the terminal.

Running the server separately

• Install the prerequisite packages with pip (e.g. by running pip install -r requirements.txt in the server directory).
• On Windows: In the server directory, either execute run-server.bat or enter run-server in the terminal.
• On Unix systems: Run the run-server.sh file (located in the server directory) in the terminal.

If you use Anaconda, you need to install the package python-dotenv. Then use the Anaconda prompt and run the flask run command.
(Note: make sure you're in the right environment, using activate <env-name>)

In all cases, you might want to add a configuration (pointing to the .bat or .sh file) in PyCharm.

Testing the client

• On Windows: Execute the run-client-test.bat file in the client directory.
• On Unix systems: Run the run-client-test.sh file (located in the client directory) in the terminal.
• Alternatively: Run npm run test in the terminal.

Testing the server

• On Windows: Execute the run-server-test.bat file in the server directory.
• On Unix systems: Run the run-server-test.sh file (located in the server directory) in the terminal.
• Alternatively: Run python -m pytest in the terminal.