{"id":20156094,"url":"https://github.com/openfun/tutor-contrib-richie","last_synced_at":"2025-04-09T22:20:58.767Z","repository":{"id":42051947,"uuid":"416689351","full_name":"openfun/tutor-contrib-richie","owner":"openfun","description":"Tutor plugin for integration of Open edX with a Richie course catalog","archived":false,"fork":false,"pushed_at":"2023-09-28T19:56:51.000Z","size":26,"stargazers_count":4,"open_issues_count":2,"forks_count":13,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-07T17:07:57.625Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openfun.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-10-13T10:19:15.000Z","updated_at":"2024-07-23T13:58:30.000Z","dependencies_parsed_at":"2022-08-12T03:30:50.752Z","dependency_job_id":null,"html_url":"https://github.com/openfun/tutor-contrib-richie","commit_stats":null,"previous_names":["overhangio/tutor-richie"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfun%2Ftutor-contrib-richie","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfun%2Ftutor-contrib-richie/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfun%2Ftutor-contrib-richie/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfun%2Ftutor-contrib-richie/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openfun","download_url":"https://codeload.github.com/openfun/tutor-contrib-richie/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247694876,"owners_count":20980733,"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:32.483Z","updated_at":"2025-04-09T22:20:58.740Z","avatar_url":"https://github.com/openfun.png","language":"Python","readme":"Richie plugin for `Tutor \u003chttps://docs.tutor.overhang.io\u003e`__\n============================================================\n\nThis is a plugin to integrate `Richie \u003chttps://richie.education/\u003e`__, the learning portal CMS, with `Open edX \u003chttps://open.edx.org\u003e`__. The integration takes the form of a `Tutor \u003chttps://docs.tutor.overhang.io\u003e`__ plugin.\n\n    ⚠ WARNING This plugin is currently undergoing major changes and is being transferred to the `openfun \u003chttps://github.com/openfun/\u003e`__ organization.\n\nInstallation\n------------\n\n::\n\n    pip install tutor-contrib-richie\n    tutor plugins enable richie\n\nRunning the Richie plugin will require that you rebuild the \"openedx\" Docker image::\n\n    tutor config save\n    tutor images build openedx\n\nThis step is necessary to install the Richie connector app in edx-platform.\n\nThen, the platform can be launched as usual with::\n\n    tutor local quickstart\n\nYou will be able to access your course catalog at http(s)://courses.LMS_HOST. In development, this url will be http://courses.local.overhang.io.\n\nGettting started\n----------------\n\nOnce your Richie platform is up and running, you will quickly realize that your learning portal is empty. This is because you should first create the corresponding courses and organizations from inside Richie. To do so, start by creating a super user::\n\n    tutor local run richie ./sandbox/manage.py createsuperuser\n\nYou can then use the credentials you just created at http(s)://yourrichiehost/admin. In development, this is http://courses.local.overhang.io/admin.\n\nThen, refer to the official `Richie documentation \u003chttps://richie.education/docs/quick-start\u003e`__ to learn how to create courses and organizations.\n\nYou may also want to fill your learning portal with a demo site -- but be careful not to run this command in production, as it will be difficult to get rid of the demo site afterwards::\n\n    # WARNING: do not attempt this in production!\n    tutor local run richie ./sandbox/manage.py create_demo_site --force\n\nConfiguration\n-------------\n\nThis Tutor plugin comes with a few configuration settings:\n\n- ``RICHIE_RELEASE_VERSION`` (default: ``\"v2.8.2\"``)\n- ``RICHIE_HOST`` (default: ``\"courses.{{ LMS_HOST }}\"``)\n- ``RICHIE_MYSQL_DATABASE`` (default: ``\"richie\"``)\n- ``RICHIE_MYSQL_USERNAME`` (default: ``\"richie\"``)\n- ``RICHIE_ELASTICSEARCH_INDICES_PREFIX`` (default: ``\"richie\"``)\n\nThese defaults should be enough for most users. To modify any one of them, run::\n\n    tutor config save --set RICHIE_SETTING_NAME=myvalue\n\nFor instance, to customize the domain name at which Richie will run::\n\n    tutor config save --set \"RICHIE_HOST=mysubdomain.{{ LMS_HOST }}\"\n\nDevelopment\n-----------\n\nBind-mount volume::\n\n    tutor dev bindmount richie /app/richie\n\nThen, run a development server::\n\n    tutor dev runserver --volume=/app/richie richie\n\nThe Richie development server will be available at http://courses.local.overhang.io:8003.\n\nTroubleshooting\n---------------\n\nDo you need help with this plugin? Get in touch with the maintainers of Richie by opening a GitHub issue: https://github.com/openfun/richie/issues/\n\nLicense\n-------\n\nThis software is licensed under the terms of the `AGPLv3 \u003chttps://www.gnu.org/licenses/agpl-3.0.en.html\u003e`__. It was developed and is being actively maintained thanks to the sponsorship of `France Université Numérique \u003chttps://github.com/openfun\u003e`__.\n\n.. image:: https://www.fun-mooc.fr/static/richie/images/logo.png\n  :alt: France Université Numérique\n  :target: https://fun-mooc.fr\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenfun%2Ftutor-contrib-richie","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenfun%2Ftutor-contrib-richie","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenfun%2Ftutor-contrib-richie/lists"}