{"id":20156120,"url":"https://github.com/openfun/joanie","last_synced_at":"2025-04-09T22:21:09.498Z","repository":{"id":36950419,"uuid":"332685566","full_name":"openfun/joanie","owner":"openfun","description":"👛 A headless ERP for education to manage course enrollment/subscription, payment and certificates delivery.","archived":false,"fork":false,"pushed_at":"2025-04-09T16:27:56.000Z","size":10524,"stargazers_count":26,"open_issues_count":63,"forks_count":2,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-04-09T17:39:17.588Z","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-01-25T08:55:35.000Z","updated_at":"2025-04-08T14:06:12.000Z","dependencies_parsed_at":"2024-02-05T05:30:57.795Z","dependency_job_id":"977ed950-0421-4b34-86bf-2c88d9e2ccf8","html_url":"https://github.com/openfun/joanie","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfun%2Fjoanie","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfun%2Fjoanie/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfun%2Fjoanie/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfun%2Fjoanie/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openfun","download_url":"https://codeload.github.com/openfun/joanie/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248120068,"owners_count":21050887,"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:39.409Z","updated_at":"2025-04-09T22:21:09.475Z","avatar_url":"https://github.com/openfun.png","language":"Python","readme":"# Joanie – Power up Richie catalog 👛\n\nJoanie is a headless ERP for education to manage course enrollment/subscription,\npayment and certificates delivery.\n\nJoanie is built on top of [Django Rest\nFramework](https://www.django-rest-framework.org/).\n\n## Getting started\n\n### Prerequisite\n\nMake sure you have a recent version of Docker and [Docker\nCompose](https://docs.docker.com/compose/install) installed on your laptop:\n\n```bash\n$ docker -v\n  Docker version 20.10.2, build 2291f61\n\n$ docker compose version\n  Docker Compose version v2.25.0\n```\n\n\u003e ⚠️ You may need to run the following commands with `sudo` but this can be\n\u003e avoided by assigning your user to the `docker` group.\n\n### Project bootstrap\n\nThe easiest way to start working on the project is to use GNU Make:\n\n```bash\n$ make bootstrap\n```\n\nThis command builds the `app` container, installs dependencies, performs\ndatabase migrations and compile translations. It's a good idea to use this\ncommand each time you are pulling code from the project repository to avoid\ndependency-releated or migration-releated issues.\n\nYour Docker services should now be up and running 🎉\n\nNote that if you need to run them afterwards, you can use the eponym Make rule:\n\n```bash\n$ make run\n```\n\n### Adding content\n\nYou can create a basic demo site by running:\n\n    $ make demo\n\n\nNow, you should be able to access the API overview interface at\n[http://localhost:8071/api/](http://localhost:8071/api/).\n\nFinally, you can check all available Make rules using:\n\n```bash\n$ make help\n```\n\nIf you're preparing for production, it is recommended to host media files in an\nobject storage.  We've cooked [Terraform](https://www.terraform.io/) scripts\nand a [documentation](docs/media.md) to make it easy if, like us, you are\nplanning to use [Swift](https://docs.openstack.org/swift). Read more about it:\n[docs/media.md](docs/media.md).\n\nIf you're planning to use AWS S3 or another object storage service, please let\nus know by opening an [issue](https://github.com/openfun/joanie/issues) or even\nbetter a [pull request](https://github.com/openfun/joanie/pulls) to add it to\nthe project.\n\n### Django admin\n\nYou can access the Django admin site at\n[http://localhost:8071/admin](http://localhost:8071/admin).\n\nYou first need to create a superuser account:\n\n```bash\n$ make superuser\n```\n\n## Guides\n\n### Explanation\n\n- [LMS Connection](https://github.com/openfun/joanie/blob/main/docs/explanation/lms-connection.md)\n- [Payment backends](https://github.com/openfun/joanie/blob/main/docs/explanation/payment-backend.md)\n\n### Reference\n\n- [Models](https://github.com/openfun/joanie/blob/main/docs/reference/models.md)\n\n## Contributing\n\nThis project is intended to be community-driven, so please, do not hesitate to\nget in touch if you have any question related to our implementation or design\ndecisions.\n\nWe try to raise our code quality standards and expect contributors to follow\nthe recommandations from our\n[handbook](https://openfun.gitbooks.io/handbook/content).\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%2Fjoanie","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenfun%2Fjoanie","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenfun%2Fjoanie/lists"}