Skip to content

Commit d33d8a1

Browse files
dcoaahmed-arb
authored andcommitted
feat: [FC-0099] include admin console as core MFE (#276)
Include admin console as core MFE.
1 parent 6358801 commit d33d8a1

7 files changed

Lines changed: 30 additions & 0 deletions

README.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ This plugin makes it possible to easily add micro frontend (MFE) applications on
55

66
In addition, this plugin comes with a few MFEs which are enabled by default:
77

8+
- `Admnistrator Console <https://github.com/openedx/frontend-app-admin-console/>`__
89
- `Authn <https://github.com/openedx/frontend-app-authn/>`__
910
- `Authoring <https://github.com/openedx/frontend-app-authoring/>`__
1011
- `Account <https://github.com/openedx/frontend-app-account/>`__
@@ -47,6 +48,14 @@ Account
4748

4849
An MFE to manage account-specific information for every LMS user. Each user's account page is available at ``http(s)://{{ MFE_HOST }}/account``. For instance, when running locally: https://apps.local.openedx.io/account.
4950

51+
Administrator Console
52+
~~~~~~~~~~~~~~~~~~~~~
53+
54+
.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/release/media/admin-console.png
55+
:alt: Account MFE screenshot
56+
57+
An MFE to manage platform-level settings and administrative tasks. To manage library teams, go to ``http(s)://{{ MFE_HOST }}/admin-console/authz/libraries/{{ LIBRARY_ID }}``.
58+
5059
Authn
5160
~~~~~
5261

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[Feature] Add admin-console to the core list of microfrontends. (by @dcoa)

media/admin-console.png

111 KB
Loading

tutormfe/patches/openedx-cms-development-settings

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,9 @@ CORS_ORIGIN_WHITELIST.append("http://{{ MFE_HOST }}:{{ get_mfe('authoring')["por
55
LOGIN_REDIRECT_WHITELIST.append("{{ MFE_HOST }}:{{ get_mfe('authoring')["port"] }}")
66
CSRF_TRUSTED_ORIGINS.append("http://{{ MFE_HOST }}:{{ get_mfe('authoring')["port"] }}")
77
{% endif %}
8+
9+
{% if get_mfe("admin-console") %}
10+
CORS_ORIGIN_WHITELIST.append("http://{{ MFE_HOST }}:{{ get_mfe("admin-console")["port"] }}")
11+
LOGIN_REDIRECT_WHITELIST.append("{{ MFE_HOST }}:{{ get_mfe("admin-console")["port"] }}")
12+
CSRF_TRUSTED_ORIGINS.append("http://{{ MFE_HOST }}:{{ get_mfe("admin-console")["port"] }}")
13+
{% endif %}

tutormfe/patches/openedx-lms-development-settings

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,11 @@ COMMUNICATIONS_MICROFRONTEND_URL = "http://{{ MFE_HOST }}:{{ get_mfe("communicat
7979
MFE_CONFIG["SCHEDULE_EMAIL_SECTION"] = True
8080
{% endif %}
8181

82+
{% if get_mfe("admin-console") %}
83+
ADMIN_CONSOLE_MICROFRONTEND_URL = "http://{{ MFE_HOST }}:{{ get_mfe("admin-console")["port"] }}/admin-console"
84+
MFE_CONFIG["ADMIN_CONSOLE_URL"] = ADMIN_CONSOLE_MICROFRONTEND_URL
85+
{% endif %}
86+
8287
# Cors configuration
8388
{% for app_name, app in iter_mfes() %}
8489
# {{ app_name }} MFE

tutormfe/patches/openedx-lms-production-settings

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,11 @@ COMMUNICATIONS_MICROFRONTEND_URL = "{% if ENABLE_HTTPS %}https://{% else %}http:
8080
MFE_CONFIG["SCHEDULE_EMAIL_SECTION"] = True
8181
{% endif %}
8282

83+
{% if get_mfe("admin-console") %}
84+
ADMIN_CONSOLE_MICROFRONTEND_URL = "{% if ENABLE_HTTPS %}https://{% else %}http://{% endif %}{{ MFE_HOST }}/admin-console"
85+
MFE_CONFIG["ADMIN_CONSOLE_URL"] = ADMIN_CONSOLE_MICROFRONTEND_URL
86+
{% endif %}
87+
8388
LOGIN_REDIRECT_WHITELIST.append("{{ MFE_HOST }}")
8489
CORS_ORIGIN_WHITELIST.append("{% if ENABLE_HTTPS %}https://{% else %}http://{% endif %}{{ MFE_HOST }}")
8590
CSRF_TRUSTED_ORIGINS.append("{% if ENABLE_HTTPS %}https://{% else %}http://{% endif %}{{ MFE_HOST }}")

tutormfe/plugin.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@
3232
}
3333

3434
CORE_MFE_APPS: dict[str, MFE_ATTRS_TYPE] = {
35+
"admin-console": {
36+
"repository": "https://github.com/openedx/frontend-app-admin-console.git",
37+
"port": 2025,
38+
},
3539
"authn": {
3640
"repository": "https://github.com/openedx/frontend-app-authn.git",
3741
"port": 1999,

0 commit comments

Comments
 (0)