{"id":20037851,"url":"https://github.com/openedx/frontend-template-application","last_synced_at":"2025-04-09T19:19:48.005Z","repository":{"id":37859536,"uuid":"123171439","full_name":"openedx/frontend-template-application","owner":"openedx","description":"A template repository for creating Open edX frontend applications. 💿➡️📀","archived":false,"fork":false,"pushed_at":"2025-04-07T11:36:48.000Z","size":17615,"stargazers_count":34,"open_issues_count":19,"forks_count":49,"subscribers_count":68,"default_branch":"master","last_synced_at":"2025-04-09T19:19:43.580Z","etag":null,"topics":["cookiecutter","frontend","template-project"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openedx.png","metadata":{"files":{"readme":"README-template-frontend-app.rst","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}},"created_at":"2018-02-27T18:34:11.000Z","updated_at":"2025-04-07T07:52:25.000Z","dependencies_parsed_at":"2024-01-01T01:22:13.816Z","dependency_job_id":"dbefef22-3518-4188-839f-fc455f96f276","html_url":"https://github.com/openedx/frontend-template-application","commit_stats":null,"previous_names":["edx/frontend-template-application"],"tags_count":24,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-template-application","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-template-application/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-template-application/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-template-application/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openedx","download_url":"https://codeload.github.com/openedx/frontend-template-application/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248094991,"owners_count":21046770,"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":["cookiecutter","frontend","template-project"],"created_at":"2024-11-13T10:23:21.852Z","updated_at":"2025-04-09T19:19:47.971Z","avatar_url":"https://github.com/openedx.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"frontend-app-[PLACEHOLDER]\n##########################\n\n.. note::\n\n  This README is a template.  As a maintainer, please review its contents and\n  update all relevant sections. Instructions to you are marked with\n  \"[PLACEHOLDER]\" or \"[TODO]\". Update or remove those sections, and remove this\n  note when you are done.\n\n|license-badge| |status-badge| |ci-badge| |codecov-badge|\n\n.. |license-badge| image:: https://img.shields.io/github/license/openedx/frontend-app-[PLACEHOLDER].svg\n    :target: https://github.com/openedx/frontend-app-[PLACEHOLDER]/blob/main/LICENSE\n    :alt: License\n\n.. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen\n\n.. |ci-badge| image:: https://github.com/openedx/frontend-app-[PLACEHOLDER]/actions/workflows/ci.yml/badge.svg\n    :target: https://github.com/openedx/frontend-app-[PLACEHOLDER]/actions/workflows/ci.yml\n    :alt: Continuous Integration\n\n.. |codecov-badge| image:: https://codecov.io/github/openedx/frontend-app-[PLACEHOLDER]/coverage.svg?branch=main\n    :target: https://codecov.io/github/openedx/frontend-app[PLACEHOLDER]?branch=main\n    :alt: Codecov\n\nPurpose\n=======\n\n.. note::\n\n   [TODO]\n\n   What is this MFE?  Add a 2-3 sentence description of what it is and what it\n   does.\n\nThis is the Awesome MFE.  It was built to provide an unmatched learning\nexperience, with improved tools for both randomized goodness and the ability to\ndirectly reference amaze-blocks in existing courses. This experience is powered\nby the new Fantastico storage engine.\n\nGetting Started\n===============\n\nDevstack Installation\n---------------------\n\n.. note::\n\n   [TODO]\n\n   Describe in detail how this MFE can be installed and set up for development\n   in a devstack.  Include as many screenshots as you can to make your guide\n   easier to follow!  Use the following steps as an example:\n\nFollow these steps to provision, run, and enable an instance of the\n[PLACEHOLDER] MFE for local development via the `devstack`_.\n\n.. _devstack: https://github.com/openedx/devstack#getting-started\n\n#. To start, clone the devstack repository as a child of an arbitrary ``~/workspace/`` directory.\n\n   .. code-block::\n\n      mkdir -p ~/workspace/\n      cd ~/workspace/\n      git clone https://github.com/openedx/devstack.git\n\n#. Configure default services and setup devstack\n\n   Create a ``devstack/options.local.mk`` file with only the services required.\n   Commonly, this will just be the LMS:\n\n   .. code-block::\n\n      DEFAULT_SERVICES ?= \\\n      lms\n\n#. Start the devstack with:\n\n   .. code-block::\n\n      cd devstack\n      make dev.pull\n      make dev.provision\n      make dev.up\n\n#. In an LMS shell, enable the ``ENABLE_[PLACEHOLDER]_MICROFRONTEND`` feature flag:\n\n   .. code-block::\n\n      make lms-shell\n      vim /edx/etc/lms.yml\n      ---\n      FEATURES:\n          ENABLE_[PLACEHOLDER]_MICROFRONTEND: true\n\n   Exit the shell and restart the LMS so changes take effect:\n\n   .. code-block::\n\n      make lms-restart\n\n#. Create and enable the waffle flag required to redirect users to the MFE,\n   enabling it for everyone:\n\n   .. code-block::\n\n      make lms-shell\n      ./manage.py lms waffle_flag --create --everyone [PLACEHOLDER].redirect_to_microfrontend\n\n#. Start this MFE with:\n\n   .. code-block::\n\n      cd frontend-app-[PLACEHOLDER]\n      nvm use\n      npm ci\n      npm start\n\n#. Finally, open the MFE in a browser\n\n   Navigate to `http://localhost:8080 \u003chttp://localhost:8080\u003e`_ to open the\n   MFE.  This is what it should look like if everything worked:\n\n   .. figure:: ./docs/images/template.jpg\n\n      \"Polycon marking template\" by mangtronix is licensed under CC BY-SA 2.0.\n\nConfiguration\n-------------\n\n.. note::\n\n   [TODO]\n\n   Explicitly list anything that this MFE requires to function correctly.  This includes:\n\n   * A list of both required and optional .env variables, and how they each\n     affect the functioning of the MFE\n\n   * A list of edx-platform `feature and waffle flags`_ that are either required\n     to enable use of this MFE, or affect the behavior of the MFE in some other\n     way\n\n   * A list of IDAs or other MFEs that this MFE depends on to function correctly\n\n.. _feature and waffle flags: https://docs.openedx.org/projects/openedx-proposals/en/latest/best-practices/oep-0017-bp-feature-toggles.html\n\nPlugins\n=======\nThis MFE can be customized using `Frontend Plugin Framework \u003chttps://github.com/openedx/frontend-plugin-framework\u003e`_.\n\nThe parts of this MFE that can be customized in that manner are documented `here \u003c/src/plugin-slots\u003e`_.\n\n[PLACEHOLDER: Other Relevant Sections]\n======================================\n\n.. note::\n\n   [TODO]\n\n   This is optional, but you might have additional sections you wish to cover.\n   For instance, architecture documentation, i18n notes, build process, or\n   more.\n\nKnown Issues\n============\n\n.. note::\n\n   [TODO]\n\n   If there are long-standing known issues, list them here as a bulletted list,\n   linking to the actual issues in the Github repository.\n\nDevelopment Roadmap\n===================\n\n.. note::\n\n   [TODO]\n\n   Include a list of current development targets, in (rough) descending order\n   of priority.  It can be a simple bulleted list of roadmap items with links\n   to Github issues or wiki pages.\n\nGetting Help\n============\n\n.. note::\n\n   [TODO]\n\n   Use the following as a template, but feel free to add specific places where\n   this MFE is commonly discussed.\n\nIf you're having trouble, we have discussion forums at\nhttps://discuss.openedx.org where you can connect with others in the community.\n\nOur real-time conversations are on Slack. You can request a `Slack\ninvitation`_, then join our `community Slack workspace`_.  Because this is a\nfrontend repository, the best place to discuss it would be in the `#wg-frontend\nchannel`_.\n\nFor anything non-trivial, the best path is to open an issue in this repository\nwith as many details about the issue you are facing as you can provide.\n\nhttps://github.com/openedx/frontend-app-[PLACEHOLDER]/issues\n\nFor more information about these options, see the `Getting Help`_ page.\n\n.. _Slack invitation: https://openedx.org/slack\n.. _community Slack workspace: https://openedx.slack.com/\n.. _#wg-frontend channel: https://openedx.slack.com/archives/C04BM6YC7A6\n.. _Getting Help: https://openedx.org/getting-help\n\nLicense\n=======\n\nThe code in this repository is licensed under the AGPLv3 unless otherwise\nnoted.\n\nPlease see `LICENSE \u003cLICENSE\u003e`_ for details.\n\nContributing\n============\n\n.. note::\n\n   [TODO]\n\n   Feel free to add contribution details specific to your repository.\n\nContributions are very welcome.  Please read `How To Contribute`_ for details.\n\n.. _How To Contribute: https://openedx.org/r/how-to-contribute\n\nThis project is currently accepting all types of contributions, bug fixes,\nsecurity fixes, maintenance work, or new features.  However, please make sure\nto have a discussion about your new feature idea with the maintainers prior to\nbeginning development to maximize the chances of your change being accepted.\nYou can start a conversation by creating a new issue on this repo summarizing\nyour idea.\n\nThe Open edX Code of Conduct\n============================\n\nAll community members are expected to follow the `Open edX Code of Conduct`_.\n\n.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/\n\nPeople\n======\n\nThe assigned maintainers for this component and other project details may be\nfound in `Backstage`_. Backstage pulls this data from the ``catalog-info.yaml``\nfile in this repo.\n\n.. _Backstage: https://open-edx-backstage.herokuapp.com/catalog/default/component/frontend-app-[PLACEHOLDER]\n\nReporting Security Issues\n=========================\n\nPlease do not report security issues in public.  Email security@openedx.org instead.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Ffrontend-template-application","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenedx%2Ffrontend-template-application","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Ffrontend-template-application/lists"}