3bij3 - A framework for testing recommender systems and their effects
How to use it
(instructions work for MacOS and Linux systems, not tested on Windows yet)
It is recommended to use this app in a virtual environment.
- Creating a virtual environment: python3 -m venv venv
- activating a virtual environment: source venv/bin/activate
To use the app, you need all the packages listed in the requirements (you can install them with sudo pip3 install -r Requirements). The way it is set up now you need an Elasticsearch database for storing the news content you want to show to the user and an MySQL or SQLite database for storing the results.
Before running the app: export FLASK_APP=3bij3.py
In addition, you also need to initialize, migrate and upgrade the database. This can be done by running:
flask db init flask db migrate flask db upgrade
During development, you can start the app by typing "flask run", it then can be found in the browser under localhost:5000
More detailed instructions on how a flask app is built can be found in a highly recommended tutorial by Miguel Grinberg which was used to build this application. Here you can also find further information on how to put the application to production.