{"id":20037796,"url":"https://github.com/openedx/frontend-app-support-tools","last_synced_at":"2025-05-05T06:31:28.843Z","repository":{"id":36967903,"uuid":"240344529","full_name":"openedx/frontend-app-support-tools","owner":"openedx","description":"Micro-frontend with a series of support tools for edx-platform","archived":false,"fork":false,"pushed_at":"2024-09-17T21:12:27.000Z","size":8204,"stargazers_count":5,"open_issues_count":35,"forks_count":18,"subscribers_count":57,"default_branch":"master","last_synced_at":"2024-09-18T07:54:09.053Z","etag":null,"topics":["pr-sandboxes-enabled"],"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.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":"2020-02-13T19:33:36.000Z","updated_at":"2024-09-16T19:53:41.000Z","dependencies_parsed_at":"2023-09-22T17:26:58.459Z","dependency_job_id":"a4a561fb-f887-4638-8f52-f4efedf1724f","html_url":"https://github.com/openedx/frontend-app-support-tools","commit_stats":null,"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-support-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-support-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-support-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-support-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openedx","download_url":"https://codeload.github.com/openedx/frontend-app-support-tools/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224428799,"owners_count":17309587,"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":["pr-sandboxes-enabled"],"created_at":"2024-11-13T10:22:18.960Z","updated_at":"2025-05-05T06:31:28.812Z","avatar_url":"https://github.com/openedx.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"##########################\nfrontend-app-support-tools\n##########################\n\n|Build Status| |Codecov| |license|\n\n*******\nPurpose\n*******\n\nThis repository contains a series of support tools for the Open edX platform.\n\n***************\nGetting Started\n***************\n\nDeveloping with Tutor\n=====================\n\n`Tutor`_ is currently recommended as a development environment for your new MFE. Please refer to the `relevant tutor-mfe documentation`_ to get started using it.\n\n.. _Tutor: https://github.com/overhangio/tutor\n.. _relevant tutor-mfe documentation: https://github.com/overhangio/tutor-mfe?tab=readme-ov-file#mfe-development\n\nDevstack (Deprecated) instructions\n==================================\n\n`Devstack \u003chttps://github.com/openedx-unsupported/devstack\u003e`_ is no longer a supported development environment.\n\nIf you start Devstack with ``make dev.up`` that should give you everything you need as a companion to this frontend.\n\n========================\nInstallation and Startup\n========================\n\n1. Clone your new repo:\n\n  ``git clone \u003cRepo URL above\u003e``\n\n2. Install npm dependencies:\n\n  ``cd frontend-app-support-tools \u0026\u0026 npm install``\n\n3. Start the dev server:\n\n  ``npm start``\n\nThe dev server is running at `http://localhost:18450 \u003chttp://localhost:18450\u003e`_.\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\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\nGetting Help\n===========\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-support-tools/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/community/connect\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\nProject Structure\n=================\n\nThe source for this project is organized into nested submodules according to the ADR `Feature-based Application Organization \u003chttps://github.com/openedx/frontend-template-application/blob/master/docs/decisions/0002-feature-based-application-organization.rst\u003e`_.\n\nBuild Process Notes\n===================\n\n================\nProduction Build\n================\n\nThe production build is created with ``npm run build``.\n\nInternationalization\n====================\n\nPlease see `edx/frontend-platform's i18n module \u003chttps://edx.github.io/frontend-platform/module-Internationalization.html\u003e`_ for documentation on internationalization.  The documentation explains how to use it, and the `How To \u003chttps://github.com/openedx/frontend-i18n/blob/master/docs/how_tos/i18n.rst\u003e`_ has more detail.\n\nReporting Security Issues\n=========================\n\nPlease do not report security issues in public. Please email security@openedx.org.\n\n.. |Build Status| image:: https://api.travis-ci.com/edx/frontend-template-application.svg?branch=master\n   :target: https://travis-ci.com/edx/frontend-template-application\n.. |Codecov| image:: https://codecov.io/gh/edx/frontend-template-application/branch/master/graph/badge.svg\n   :target: https://codecov.io/gh/edx/frontend-template-application\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Ffrontend-app-support-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenedx%2Ffrontend-app-support-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Ffrontend-app-support-tools/lists"}