https://github.com/openedx/frontend-app-support-tools
Micro-frontend with a series of support tools for edx-platform
https://github.com/openedx/frontend-app-support-tools
pr-sandboxes-enabled
Last synced: about 1 year ago
JSON representation
Micro-frontend with a series of support tools for edx-platform
- Host: GitHub
- URL: https://github.com/openedx/frontend-app-support-tools
- Owner: openedx
- License: agpl-3.0
- Created: 2020-02-13T19:33:36.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-17T21:12:27.000Z (almost 2 years ago)
- Last Synced: 2024-09-18T07:54:09.053Z (almost 2 years ago)
- Topics: pr-sandboxes-enabled
- Language: JavaScript
- Homepage:
- Size: 7.82 MB
- Stars: 5
- Watchers: 57
- Forks: 18
- Open Issues: 35
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
##########################
frontend-app-support-tools
##########################
|Build Status| |Codecov| |license|
*******
Purpose
*******
This repository contains a series of support tools for the Open edX platform.
***************
Getting Started
***************
Developing with Tutor
=====================
`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.
.. _Tutor: https://github.com/overhangio/tutor
.. _relevant tutor-mfe documentation: https://github.com/overhangio/tutor-mfe?tab=readme-ov-file#mfe-development
Devstack (Deprecated) instructions
==================================
`Devstack `_ is no longer a supported development environment.
If you start Devstack with ``make dev.up`` that should give you everything you need as a companion to this frontend.
========================
Installation and Startup
========================
1. Clone your new repo:
``git clone ``
2. Install npm dependencies:
``cd frontend-app-support-tools && npm install``
3. Start the dev server:
``npm start``
The dev server is running at `http://localhost:18450 `_.
License
=======
The code in this repository is licensed under the AGPLv3 unless otherwise
noted.
Please see `LICENSE `_ for details.
Contributing
============
Contributions are very welcome. Please read `How To Contribute`_ for details.
.. _How To Contribute: https://openedx.org/r/how-to-contribute
This project is currently accepting all types of contributions, bug fixes,
security fixes, maintenance work, or new features. However, please make sure
to have a discussion about your new feature idea with the maintainers prior to
beginning development to maximize the chances of your change being accepted.
You can start a conversation by creating a new issue on this repo summarizing
your idea.
Getting Help
===========
If you're having trouble, we have discussion forums at
https://discuss.openedx.org where you can connect with others in the community.
Our real-time conversations are on Slack. You can request a `Slack
invitation`_, then join our `community Slack workspace`_. Because this is a
frontend repository, the best place to discuss it would be in the `#wg-frontend
channel`_.
For anything non-trivial, the best path is to open an issue in this repository
with as many details about the issue you are facing as you can provide.
https://github.com/openedx/frontend-app-support-tools/issues
For more information about these options, see the `Getting Help`_ page.
.. _Slack invitation: https://openedx.org/slack
.. _community Slack workspace: https://openedx.slack.com/
.. _#wg-frontend channel: https://openedx.slack.com/archives/C04BM6YC7A6
.. _Getting Help: https://openedx.org/community/connect
The Open edX Code of Conduct
============================
All community members are expected to follow the `Open edX Code of Conduct`_.
.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/
Project Structure
=================
The source for this project is organized into nested submodules according to the ADR `Feature-based Application Organization `_.
Build Process Notes
===================
================
Production Build
================
The production build is created with ``npm run build``.
Internationalization
====================
Please see `edx/frontend-platform's i18n module `_ for documentation on internationalization. The documentation explains how to use it, and the `How To `_ has more detail.
Reporting Security Issues
=========================
Please do not report security issues in public. Please email security@openedx.org.
.. |Build Status| image:: https://api.travis-ci.com/edx/frontend-template-application.svg?branch=master
:target: https://travis-ci.com/edx/frontend-template-application
.. |Codecov| image:: https://codecov.io/gh/edx/frontend-template-application/branch/master/graph/badge.svg
:target: https://codecov.io/gh/edx/frontend-template-application