From 8f698a79a5167ab170c7b0bf086840969360a470 Mon Sep 17 00:00:00 2001 From: Deborah Kaplan Date: Thu, 22 Feb 2024 20:43:20 +0000 Subject: [PATCH] feat: adding two MFEs to devstack * frontend-app-learner-record * frontend-app-learner-dashboard FIXES: APER-3211 --- .gitignore | 3 +++ docker-compose-host.yml | 12 ++++++++++++ docker-compose.yml | 30 ++++++++++++++++++++++++++++++ docs/service_list.rst | 6 ++++++ options.mk | 2 +- repo.sh | 4 ++++ 6 files changed, 56 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index d7ea3b685a..b6f9c11efe 100644 --- a/.gitignore +++ b/.gitignore @@ -88,6 +88,9 @@ ENV/ # OS X .DS_Store +# VSCode +.vscode/ + # PyCharm .idea/ diff --git a/docker-compose-host.yml b/docker-compose-host.yml index ca09f22c5b..2f532d505d 100644 --- a/docker-compose-host.yml +++ b/docker-compose-host.yml @@ -93,6 +93,16 @@ services: - ${DEVSTACK_WORKSPACE}/frontend-app-ora-grading:/edx/app/frontend-app-ora-grading - frontend_app_ora_grading_node_modules:/edx/app/frontend-app-ora-grading/node_modules - ${DEVSTACK_WORKSPACE}/src:/edx/app/src + frontend-app-learner-dashboard: + volumes: + - ${DEVSTACK_WORKSPACE}/frontend-app-learner-dashboard:/edx/app/frontend-app-learner-dashboard + - frontend_app_learner_dashboard_node_modules:/edx/app/frontend-app-learner-dashboard/node_modules + - ${DEVSTACK_WORKSPACE}/src:/edx/app/src + frontend-app-learner-record: + volumes: + - ${DEVSTACK_WORKSPACE}/frontend-app-learner-record:/edx/app/frontend-app-learner-record + - frontend_app_learner_record_node_modules:/edx/app/frontend-app-learner-record/node_modules + - ${DEVSTACK_WORKSPACE}/src:/edx/app/src frontend-app-learning: volumes: - ${DEVSTACK_WORKSPACE}/frontend-app-learning:/edx/app/frontend-app-learning @@ -133,6 +143,8 @@ volumes: frontend_app_course_authoring_node_modules: frontend_app_gradebook_node_modules: frontend_app_ora_grading_node_modules: + frontend_app_learner_dashboard_node_modules: + frontend_app_learner_record_node_modules: frontend_app_learning_node_modules: frontend_app_library_authoring_node_modules: frontend_app_payment_node_modules: diff --git a/docker-compose.yml b/docker-compose.yml index aaf867834a..8d8a0dfe31 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -759,6 +759,36 @@ services: depends_on: - lms + frontend-app-learner-dashboard: + extends: + file: microfrontend.yml + service: microfrontend + working_dir: '/edx/app/frontend-app-learner-dashboard' + container_name: "edx.${COMPOSE_PROJECT_NAME:-devstack}.frontend-app-learner-dashboard" + networks: + default: + aliases: + - edx.devstack.frontend-app-learner-dashboard + ports: + - "1996:1996" + depends_on: + - lms + + frontend-app-learner-record: + extends: + file: microfrontend.yml + service: microfrontend + working_dir: '/edx/app/frontend-app-learner-record' + container_name: "edx.${COMPOSE_PROJECT_NAME:-devstack}.frontend-app-learner-record" + networks: + default: + aliases: + - edx.devstack.frontend-app-learner-record + ports: + - "1990:1990" + depends_on: + - lms + frontend-app-learning: extends: file: microfrontend.yml diff --git a/docs/service_list.rst b/docs/service_list.rst index 8dd2cccf4e..ec01b391d5 100644 --- a/docs/service_list.rst +++ b/docs/service_list.rst @@ -27,6 +27,10 @@ Instead of a service name or list, you can also run commands like ``make dev.pro +------------------------------------+-------------------------------------+----------------+--------------+ | `edx_notes_api`_ | http://localhost:18120/api/v1/ | Python/Django | Default | +------------------------------------+-------------------------------------+----------------+--------------+ +| `frontend-app-learner-dashboard`_ | http://localhost:1996/ | MFE (React.js) | Default | ++------------------------------------+-------------------------------------+----------------+--------------+ +| `frontend-app-learner-record`_ | http://localhost:1990/ | MFE (React.js) | Default | ++------------------------------------+-------------------------------------+----------------+--------------+ | `frontend-app-learning`_ | http://localhost:2000/ | MFE (React.js) | Default | +------------------------------------+-------------------------------------+----------------+--------------+ | `frontend-app-payment`_ | http://localhost:1998/ | MFE (React.js) | Default | @@ -78,6 +82,8 @@ Some common service combinations include: .. _frontend-app-program-console: https://github.com/openedx/frontend-app-program-console .. _registrar: https://github.com/openedx/registrar .. _cms: https://github.com/openedx/edx-platform +.. _frontend-app-learner-dashboard: https://github.com/openedx/frontend-app-learner-dashboard +.. _frontend-app-learner-record: https://github.com/openedx/frontend-app-learner-record .. _frontend-app-learning: https://github.com/openedx/frontend-app-learning .. _frontend-app-library-authoring: https://github.com/openedx/frontend-app-library-authoring .. _frontend-app-course-authoring: https://github.com/openedx/frontend-app-course-authoring diff --git a/options.mk b/options.mk index 7e3eea76cc..304cbbd59a 100644 --- a/options.mk +++ b/options.mk @@ -67,7 +67,7 @@ credentials+discovery+ecommerce+edx_notes_api+forum+frontend-app-authn+frontend- # Separated by plus signs. # Separated by plus signs. Listed in alphabetical order for clarity. EDX_SERVICES ?= \ -analyticsapi+credentials+discovery+ecommerce+edx_notes_api+forum+frontend-app-account+frontend-app-profile+frontend-app-authn+frontend-app-course-authoring+frontend-app-gradebook+frontend-app-ora-grading+frontend-app-learning+frontend-app-library-authoring+frontend-app-payment+frontend-app-program-console+frontend-app-publisher+insights+lms+lms_watcher+registrar+registrar-worker+cms+cms_watcher+xqueue+xqueue_consumer +analyticsapi+credentials+discovery+ecommerce+edx_notes_api+forum+frontend-app-account+frontend-app-learner-dashboard+frontend-app-learner-record+frontend-app-profile+frontend-app-authn+frontend-app-course-authoring+frontend-app-gradebook+frontend-app-ora-grading+frontend-app-learning+frontend-app-library-authoring+frontend-app-payment+frontend-app-program-console+frontend-app-publisher+insights+lms+lms_watcher+registrar+registrar-worker+cms+cms_watcher+xqueue+xqueue_consumer # Services with database migrations. # Should be a subset of $(EDX_SERVICES). diff --git a/repo.sh b/repo.sh index cc4d22ad7b..aab69bdccd 100755 --- a/repo.sh +++ b/repo.sh @@ -30,6 +30,8 @@ repos=( "https://github.com/openedx/xqueue.git" "https://github.com/openedx/edx-analytics-dashboard.git" "https://github.com/openedx/frontend-app-gradebook.git" + "https://github.com/openedx/frontend-app-learner-dashboard" + "https://github.com/openedx/frontend-app-learner-record" "https://github.com/openedx/frontend-app-payment.git" "https://github.com/openedx/frontend-app-publisher.git" "https://github.com/openedx/edx-analytics-dashboard.git" @@ -58,6 +60,8 @@ ssh_repos=( "git@github.com:openedx/xqueue.git" "git@github.com:openedx/edx-analytics-dashboard.git" "git@github.com:openedx/frontend-app-gradebook.git" + "git@github.com:openedx/frontend-app-learner-dashboard.git" + "git@github.com:openedx/frontend-app-learner-record.git" "git@github.com:openedx/frontend-app-payment.git" "git@github.com:openedx/frontend-app-publisher.git" "git@github.com:openedx/edx-analytics-dashboard.git"