Zeeguu is an open API that allows tracking and modeling the progress of a learner in a foreign language with the goal of recommending paths to accelerate vocabulary acquisition.

The API offers translations for the words that a learner encounters in his readings. The history of the translated words and their context is saved and used to build a dynamic model of the user knowledge. The context is used to extract the words the user knows and their topics of interest.

A teacher agent recommends the most important words to be studied next in order for the learner to accelerate his vocabulary retention. This information can be used as input by language exercise applications, for example interactive games.

A text recommender agent crawls websites of interest to the user and recommend materials to read which are in the zone of proximal development.

The API is available at https://zeeguu.unibe.ch/api.

1. Install Zeeguu-Core. The API is a thin layer on top of it.

2. Make sure to activate the virtualenv in which you installed Zeeguu-Core! Most of the packages required by the API, including Core, are already installed there.

3. Clone this repo and run python setup.py develop from within the cloned folder.

4. Test that your installation works with:

   ./run_tests.sh

5. To try out the API you can run ./api_test.sh which will by default create a test_zeeguu mysql db which is in sync with the data in the default_api.cfg file and start the server with that configuration.

6. To make sure that the API works, you can call the /available_languages endpoint from another terminal (or after having moved the current process to the bacgkround) like this:

   curl localhost:9001/available_languages

7. If the answer is something like ["de", "es", "fr", "nl", "en"] you have the API working.

Go have fun!