{"id":19164563,"url":"https://github.com/heliumedu/platform","last_synced_at":"2025-05-07T12:13:42.513Z","repository":{"id":27366252,"uuid":"111345658","full_name":"HeliumEdu/platform","owner":"HeliumEdu","description":"Django backend of Helium's planner application","archived":false,"fork":false,"pushed_at":"2025-05-06T20:17:24.000Z","size":8530,"stargazers_count":20,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-07T12:13:36.712Z","etag":null,"topics":["api","backend","calendar","django","django-rest-framework","docker","education","planner","python","student"],"latest_commit_sha":null,"homepage":"https://www.heliumedu.com","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/HeliumEdu.png","metadata":{"files":{"readme":"README.md","changelog":null,"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,"zenodo":null},"funding":{"github":"alexdlaird","patreon":"alexdlaird","custom":["https://www.paypal.me/alexdlaird"]}},"created_at":"2017-11-20T01:01:17.000Z","updated_at":"2025-05-06T20:17:28.000Z","dependencies_parsed_at":"2024-04-15T12:24:47.162Z","dependency_job_id":"31d069a4-ba75-424f-ab75-404c5dd32bfe","html_url":"https://github.com/HeliumEdu/platform","commit_stats":null,"previous_names":[],"tags_count":122,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HeliumEdu%2Fplatform","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HeliumEdu%2Fplatform/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HeliumEdu%2Fplatform/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HeliumEdu%2Fplatform/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HeliumEdu","download_url":"https://codeload.github.com/HeliumEdu/platform/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252873884,"owners_count":21817715,"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":["api","backend","calendar","django","django-rest-framework","docker","education","planner","python","student"],"created_at":"2024-11-09T09:22:46.334Z","updated_at":"2025-05-07T12:13:42.484Z","avatar_url":"https://github.com/HeliumEdu.png","language":"Python","funding_links":["https://github.com/sponsors/alexdlaird","https://patreon.com/alexdlaird","https://www.paypal.me/alexdlaird"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"https://www.heliumedu.com/assets/img/logo_full_blue.png\" /\u003e\u003c/p\u003e\n\n![Python Versions](https://img.shields.io/badge/python-%203.12%20-blue)\n[![Coverage](https://img.shields.io/codecov/c/github/HeliumEdu/platform)](https://codecov.io/gh/HeliumEdu/platform)\n[![Build](https://img.shields.io/github/actions/workflow/status/HeliumEdu/platform/build.yml)](https://github.com/HeliumEdu/platform/actions/workflows/build.yml)\n[![Code Quality](https://app.codacy.com/project/badge/Grade/0cb1b256044e43739735987214f3a796)](https://app.codacy.com/gh/HeliumEdu/platform/dashboard?utm_source=gh\u0026utm_medium=referral\u0026utm_content=\u0026utm_campaign=Badge_grade)\n![GitHub License](https://img.shields.io/github/license/heliumedu/platform)\n\n# Helium Platform Project\n\n## Prerequisites\n\n- Docker\n- Python (\u003e= 3.12)\n- MySQL (\u003e= 8)\n- Redis (\u003e= 5)\n\n## Getting Started\n\nThe `platform` is developed using Python and [Django](https://www.djangoproject.com).\n\nThis project is configured to work with a [Virtualenv](https://virtualenv.pypa.io/en/stable) within a\n[Docker](https://www.docker.com/) container. Once provisioned, development can be done offline, as the container built\nfor development includes [LocalStack](https://www.localstack.cloud/) to emulate AWS services locally.\n\n## Development\n### Docker Setup\n\nTo provision the Docker container with the Python/Django `platform` build and all dependencies, execute:\n\n```sh\nbin/runserver\n```\n\nThis builds and starts two containers, one for the API (named `helium_platform_api`), and one for the Worker\n(named `helium_platform_worker`). Once running, the `platform` API is available at http://localhost:8000, and the\n`platform` Worker is running to execute async and scheduled tasks. The shell of containers can be accessed using their\nname, like:\n\n```shell\ndocker exec -it platform-api-1 /bin/bash\n```\n\nInside the `platform` container, you can run Django commands against the app, like:\n\n```sh\npython manage.py migrate\npython manage.py createsuperuser\n```\n\n### Project Information\n\nThe `platform` is split up into several modules, all contained within this repository.  The base configuration is\ndefined under `conf`. The applications within this project are:\n\n- auth\n- common\n- feed\n- importexport\n- planner\n\nThere are also some special environment variables that can be set in development or deployment of the project:\n\n- `ENVIRONMENT`\n  - `dev-local` provisions hosts as `localhost`\n  - `local` provisions hosts as `localhost` for use outside of Docker (ex. when using Django's `runserver` command) \n  - `prod` provisions hosts to be suffixed with `heliumedu.com`\n  - Any other env name provisions a prod-like hostname with `\u003cENVIRONMENT\u003e.` as the prefix\n- `PLATFORM_BEAT_MODE`\n  - Set to `True` to start a Beat scheduler (only one should ever be running in the fleet) instead of a Worker when launching from [Celery](https://docs.celeryq.dev/en/stable/getting-started/introduction.html)\n- `USE_AWS_SECRETS_MANAGER`\n  - Set to `True` to use AWS Secrets Manager before falling back to environment variables\n- `USE_NGROK`\n  - Set to `True` to have [pyngrok](https://github.com/alexdlaird/pyngrok) open a `ngrok` tunnel and provide a real hostname (only works when `ENVIRONMENT` is not `prod`\n\nThese and other environment variables can be configured in the `.env` file. This is also where credentials to\nthird-party services (for example, AWS services like SES) can be set. Do NOT commit real credentials to third-party\nservices, even in example files.\n\nBefore commits are made, be sure to run tests and check the generated coverage report.\n\n```sh\nmake test\n```\n\n### Frontend\n\nThe `frontend` is served from a separate repository and can be found [here](https://github.com/HeliumEdu/frontend#readme).\nUsing Docker, the `frontend` and `platform` containers can be started alongside each other using to almost entirely\nemulate a prod-like environment locally using [the deploy project](https://github.com/HeliumEdu/deploy). For\nfunctionality that still requires Internet-connected external services (ex. emails and text messages), provision\n[the `dev-local` Terraform Workspace](https://github.com/HeliumEdu/deploy/tree/main/terraform/environments/dev-local),\nwhich is meant to work alongside local Docker development. \n\nNote that the `frontend` was previously bundled, rendered, and served as a part of this project, but it was pulled out\ninto its own project with the with `1.4.0` release. For reference, checkout the `1.3.8` tag or download it [here](https://github.com/HeliumEdu/platform/releases/tag/1.3.8)\nto see how this was previously done.\n\n### Documentation\n\nAuto-generated API documentation is accessible via any environment at /docs. Additional documentation can be found\non the [Platform Wiki](https://github.com/HeliumEdu/platform/wiki/Helium-Platform-Documentation).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheliumedu%2Fplatform","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fheliumedu%2Fplatform","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheliumedu%2Fplatform/lists"}