Compare commits

..

2 Commits

Author SHA1 Message Date
Brian Smith
0cb95abe14 fix: import FooterSlot from frontend-slot-footer package 2024-06-06 15:05:06 -03:00
Brian Smith
4b4ba11932 feat: use frontend-plugin-framework to provide a FooterSlot 2024-06-06 15:05:06 -03:00
7 changed files with 11274 additions and 6465 deletions

View File

@@ -9,9 +9,6 @@ on:
jobs:
tests:
runs-on: ubuntu-latest
strategy:
matrix:
node: [18, 20]
steps:
- name: Checkout
@@ -21,9 +18,9 @@ jobs:
- name: Setup Nodejs Env
run: echo "NODE_VER=`cat .nvmrc`" >> $GITHUB_ENV
- name: Setup Nodejs
uses: actions/setup-node@v4
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node }}
node-version: ${{ env.NODE_VER }}
- name: Install dependencies
run: npm ci
- name: Validate package-lock.json changes
@@ -37,7 +34,4 @@ jobs:
- name: i18n_extract
run: npm run i18n_extract
- name: Coverage
uses: codecov/codecov-action@v4
with:
token: ${{ secrets.CODECOV_TOKEN }}
fail_ci_if_error: true
uses: codecov/codecov-action@v3

View File

@@ -10,4 +10,4 @@ on:
jobs:
version-check:
uses: openedx/.github/.github/workflows/lockfileversion-check-v3.yml@master
uses: openedx/.github/.github/workflows/lockfile-check.yml@master

2
.nvmrc
View File

@@ -1,2 +1,2 @@
20
18

View File

@@ -37,10 +37,11 @@ pull_translations:
translations/frontend-component-header/src/i18n/messages:frontend-component-header \
translations/frontend-component-footer/src/i18n/messages:frontend-component-footer \
translations/paragon/src/i18n/messages:paragon \
translations/frontend-lib-content-components/src/i18n/messages:frontend-lib-content-components \
translations/frontend-platform/src/i18n/messages:frontend-platform \
translations/frontend-app-communications/src/i18n/messages:frontend-app-communications
$(intl_imports) frontend-component-header frontend-component-footer paragon frontend-platform frontend-app-communications
$(intl_imports) frontend-component-header frontend-component-footer paragon frontend-lib-content-components frontend-platform frontend-app-communications
# This target is used by Travis.
validate-no-uncommitted-package-lock-changes:

View File

@@ -1,5 +1,5 @@
frontend-app-communications
###########################
#############################
|license-badge| |status-badge| |ci-badge| |codecov-badge|
@@ -7,56 +7,52 @@ frontend-app-communications
Purpose
*******
A tool used by course teams to communicate with their learners. The interface for anything related to instructor-to-learner communications. Instructor bulk email, for example.
A tool used by course teams to communicate with their learners. The interface for anything related to instructor to learner communications. Instructor bulk email, for example.
Getting started
---------------
------------
For now, this repo is not integrated with devstack. You'll be running the app locally and not through docker. This does make setup a little easier.
For now, this repo is not intergrated with devstack. You'll be running the app locally and not through docker. This does make setup a little easier.
Cloning and Startup
===================
1. Clone your new repo:
1. Clone your new repo:
.. code-block:: bash
``git clone https://github.com/edx/frontend-app-communications.git``
git clone https://github.com/edx/frontend-app-communications.git
2. Use node v18.x.
2. Use node v18.x.
The current version of the micro-frontend build scripts support node 18.
Using other major versions of node *may* work, but this is unsupported. For
convenience, this repository includes an .nvmrc file to help in setting the
correct node version via `nvm <https://github.com/nvm-sh/nvm>`_.
The current version of the micro-frontend build scripts supports node 18.
Using other major versions of node *may* work, but this is unsupported. For
convenience, this repository includes a ``.nvmrc`` file to help in setting the
correct node version via `nvm <https://github.com/nvm-sh/nvm>`_.
3. Install npm dependencies:
3. Install npm dependencies:
``cd frontend-app-communications && npm install``
.. code-block:: bash
4. Update the application port to use for local development:
cd frontend-app-communications && npm install
Default port is 1984. If this does not work for you, update the line
`PORT=1984` to your port in all .env.* files
4. Update the application port to use for local development:
5. Start the devserver. The app will be running at ``localhost:1984``, or whatever port you change it too.
The default port is 1984. If this does not work for you, update the line
``PORT=1984`` to your port in all ``.env.*`` files
.. code-block::
5. Start the devserver. The app will be running at ``localhost:1984``, or whatever port you change it too.
.. code-block:: bash
npm start
npm start
Environment Variables/Setup Notes
---------------------------------
If you wish to add new environment variables for local testing, they should be listed in 2 places:
If you wish to add new environment varibles for local testing, they should be listed in 2 places:
1. In ``.env.development``
2. Added to the ``mergeConfig`` found in ``src/index.jsx``
.. code-block:: jsx
.. code-block::
initialize({
config: () => {
@@ -65,13 +61,13 @@ If you wish to add new environment variables for local testing, they should be l
}, 'CommuncationsAppConfig');
Running Tests
-------------
---------------------------
Tests use `jest` and `react-test-library`. To run all the tests for this repo:
.. code-block::
.. code-block::
npm test
npm test
Plugins
=======
@@ -86,7 +82,7 @@ The production build is created with ``npm run build``.
Internationalization
====================
Please refer to the `frontend-platform i18n howto`_ for documentation on
Please see refer to the `frontend-platform i18n howto`_ for documentation on
internationalization.
.. _frontend-platform i18n howto: https://github.com/openedx/frontend-platform/blob/master/docs/how_tos/i18n.rst
@@ -169,4 +165,4 @@ Please do not report security issues in public, and email security@openedx.org i
.. |codecov-badge| image:: https://codecov.io/github/openedx/frontend-app-communications/coverage.svg?branch=master
:target: https://codecov.io/github/openedx/frontend-app-communications?branch=master
:alt: Codecov
:alt: Codecov

17656
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -34,8 +34,8 @@
},
"dependencies": {
"@edx/brand": "npm:@openedx/brand-openedx@^1.2.2",
"@edx/frontend-component-header": "^5.6.0",
"@edx/frontend-platform": "^8.0.0",
"@edx/frontend-component-header": "5.0.2",
"@edx/frontend-platform": "7.0.1",
"@edx/openedx-atlas": "^0.6.0",
"@edx/tinymce-language-selector": "1.1.0",
"@fortawesome/fontawesome-svg-core": "1.2.36",
@@ -65,14 +65,14 @@
},
"devDependencies": {
"@edx/browserslist-config": "^1.2.0",
"@openedx/frontend-build": "14.0.3",
"@edx/reactifex": "^2.1.1",
"@openedx/frontend-build": "13.0.27",
"@testing-library/jest-dom": "5.16.5",
"@testing-library/react": "12.1.5",
"axios-mock-adapter": "1.21.2",
"glob": "7.2.3",
"husky": "7.0.4",
"jest": "29.7.0",
"jest": "27.5.1",
"prettier": "2.8.1",
"rosie": "2.1.0"
}