{"id":20156104,"url":"https://github.com/openfun/learning-analytics-playground","last_synced_at":"2025-04-09T22:21:02.506Z","repository":{"id":39973022,"uuid":"364278570","full_name":"openfun/learning-analytics-playground","owner":"openfun","description":":factory: A playground using OpenEdx to generate factice learning logs","archived":false,"fork":false,"pushed_at":"2024-08-23T13:58:38.000Z","size":214,"stargazers_count":4,"open_issues_count":5,"forks_count":1,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-03-24T00:14:09.918Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openfun.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-05-04T14:12:43.000Z","updated_at":"2024-01-23T15:30:14.000Z","dependencies_parsed_at":"2024-08-23T15:37:23.194Z","dependency_job_id":null,"html_url":"https://github.com/openfun/learning-analytics-playground","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfun%2Flearning-analytics-playground","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfun%2Flearning-analytics-playground/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfun%2Flearning-analytics-playground/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfun%2Flearning-analytics-playground/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openfun","download_url":"https://codeload.github.com/openfun/learning-analytics-playground/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248120060,"owners_count":21050886,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T23:37:35.242Z","updated_at":"2025-04-09T22:21:02.484Z","avatar_url":"https://github.com/openfun.png","language":"Python","readme":"# Learning analytics playground\n\n## Description\n\nThis tool is dedicated to generate learning events (_aka_ tracking logs) from a LMS platform to\nfeed dashboard development testing datasets. It is intended to be used locally.\n\n## Usage\n\n### Launch Edx platform\n\n1. Run the following command to launch the Edx platform:\n\n```\nmake bootstrap\nmake run-edx\n```\n\n\u003e Note: as the command includes migrations, it may take some time to complete (several minutes).\n\u003e Go grab a coffee, a tea or whatever pleases you!\n\n2. When connections are established, you can access to:\n\n   - the LMS server on [localhost:8072](http://localhost:8072)\n   - the CMS server on [localhost:8082](http://localhost:8082)\n   - the Graylog server on [localhost:9000](http://localhost:9000)\n\n3. Two users are available for testing the LMS/CMS:\n\n| Role    | Email            | Password |\n| ------- | ---------------- | -------- |\n| admin   | admin@example.com | admin    |\n| student | edx@example.com  | edx      |\n\n\u003e Note that it is also possible to create customized users at your convenience,\n\u003e but remember that those accounts will not persist if you remove the database container.\n\n### Run end-to-end tests\n\nIn this playground, end-to-end tests have been implemented to simulate learning events generation.\n\nAs this project is evolving, the tests will progressively comprises a wide panel of use cases.\n\nThe following command runs end-to-end tests:\n\n```\nmake test\n```\n\n## Graylog\n\nGenerated events with end-to-end tests or with manual navigation on the LMS service are observable on the Graylog server.\n\n### Configure an input on Graylog interface\n\n1. Access Graylog interface with `admin`:`admin` credentials.\n\n2. To configure the input where to listen the LMS server, click on `System` bar menu and `Inputs`\n   button.\n\n3. On Select input, choose `GELF TCP` and click on \u003ckbd\u003eLaunch new input\u003c/kbd\u003e button.\n\n4. In the input window appearing, enter the input title you want.\n\n5. Check that binding adress is `0.0.0.0` and the listening port is 12201.\n\n6. Ensure that `Null frame delimiter?` option is activated (on the bottom of the windows),\n   otherwise logs won't be recognized and streamed.\n\n7. Click on \u003ckbd\u003eSave\u003c/kbd\u003e button.\n\n### Stream events\n\n1. Go on LMS server and navigate through the website.\n\n2. On the Graylog server, go on `Search` and update the timeframe on `Search in all messages`\n   option if no logs are visible.\n\n3. You should see appearing a list of all the messages you have generated!\n\n## Keycloak\n\nThe keycloak SSO service is pre-configured for the `fun-mooc` realm. \n\nUse the _ad hoc_ Make target to run the service: \n\n```\nmake run-keycloak\n```\n\nIt can be accessed at `http://localhost:8080`. \nAdmin credentials are: `admin:pass`.\n\nThe `potsie` client has been configured to login to `grafana` (see\nthe [openfun/potsie](https://github.com/openfun/potsie) project). \n\nUse the _ad hoc_ Make target to provision `fun-mooc` realm: \n\n```\nmake realm\n```\n\nYou can now login to grafana using the following credentials:\n`grafana:funfunfun`.\n\n## License\n\nThis work is released under the MIT license (see [LICENSE](./LICENSE)).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenfun%2Flearning-analytics-playground","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenfun%2Flearning-analytics-playground","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenfun%2Flearning-analytics-playground/lists"}