Skip to content

Commit

Permalink
refactor: remove extra customizations
Browse files Browse the repository at this point in the history
  • Loading branch information
asadali145 committed Jan 25, 2024
1 parent 9ed2543 commit c4ad876
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 35 deletions.
3 changes: 0 additions & 3 deletions .env.development
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,11 @@ LOGO_TRADEMARK_URL=https://edx-cdn.org/v3/default/logo-trademark.svg
LOGO_WHITE_URL=https://edx-cdn.org/v3/default/logo-white.svg
FAVICON_URL=https://edx-cdn.org/v3/default/favicon.ico
ABOUT_US_URL=
PRIVACY_POLICY_URL=
HONOR_CODE_URL=
TERMS_OF_SERVICE_URL=
CONTACT_URL=
SUPPORT_CENTER_URL=
SUPPORT_CENTER_TEXT=
TRADEMARK_TEXT=
SITE_URL=
LOGO_ALT_TEXT=
SHOW_LOGO=
SUPPORT_EMAIL=
36 changes: 12 additions & 24 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -184,27 +184,15 @@ Reporting Security Issues
=========================

Please do not report security issues in public. Please email [email protected].
=======
***********
Local Development
***********

For local development and testing follow these steps. (for convenience sake consider learning MFE as parent app)

* Clone frontend-component-footer-mitol into frontend-app-learning directory.
* CD into the frontend-component-footer-mitol and run the following commands::
npm i

npm build
* Verify a `dist/` directory has been created.
* CD back into frontend-app-learning and create a module.config.js file
* Place the following code in the module.config.js::

module.exports = {
localModules: [
{ moduleName: '@edx/frontend-component-footer', dir: './frontend-component-footer-mitol' },
}

* Restart frontend-app-learning and verify it is using the local version from @edx/frontend-component-footer
* For css changes you might need to rebuild again.
.. |Build Status| image:: https://api.travis-ci.com/edx/frontend-component-footer.svg?branch=master
:target: https://travis-ci.com/edx/frontend-component-footer
.. |Codecov| image:: https://img.shields.io/codecov/c/github/edx/frontend-component-footer
:target: @edx/frontend-component-footer
.. |npm_version| image:: https://img.shields.io/npm/v/@edx/frontend-component-footer.svg
:target: @edx/frontend-component-footer
.. |npm_downloads| image:: https://img.shields.io/npm/dt/@edx/frontend-component-footer.svg
:target: @edx/frontend-component-footer
.. |license| image:: https://img.shields.io/npm/l/@edx/frontend-component-footer.svg
:target: @edx/frontend-component-footer
.. |semantic-release| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
:target: https://github.com/semantic-release/semantic-release
13 changes: 6 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@mitodl/frontend-component-footer-mitol",
"name": "@edx/frontend-component-footer-mitol",
"version": "1.0.0-semantically-released",
"description": "Footer component for use when building Open edX frontend applications for MITX",
"description": "Footer component for use when building Open edX frontend applications",
"main": "dist/index.js",
"publishConfig": {
"access": "public"
Expand All @@ -25,14 +25,14 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/mitodl/frontend-component-footer-mitol"
"url": "git+https://github.com/openedx/frontend-component-footer.git"
},
"author": "MIT",
"author": "edX",
"license": "AGPL-3.0",
"bugs": {
"url": "https://github.com/mitodl/frontend-component-footer-mitol/issues"
"url": "https://github.com/openedx/frontend-component-footer/issues"
},
"homepage": "https://github.com/mitodl/frontend-component-footer-mitol#readme",
"homepage": "https://github.com/openedx/frontend-component-footer#readme",
"devDependencies": {
"@edx/brand": "npm:@openedx/brand-openedx@^1.2.2",
"@edx/browserslist-config": "^1.1.1",
Expand Down Expand Up @@ -63,7 +63,6 @@
"peerDependencies": {
"@edx/frontend-platform": "^7.0.0",
"@openedx/paragon": ">= 21.11.3 < 23.0.0",
"@edx/paragon": "<22.0.0",
"prop-types": "^15.5.10",
"react": "^16.9.0 || ^17.0.0",
"react-dom": "^16.9.0 || ^17.0.0"
Expand Down
2 changes: 1 addition & 1 deletion src/components/Footer.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ class SiteFooter extends React.Component {
&& (
<a
className="d-block"
href={process.env.SITE_URL}
href={config.LMS_BASE_URL}
aria-label={intl.formatMessage(messages['footer.logo.ariaLabel'])}
>
<img
Expand Down

0 comments on commit c4ad876

Please sign in to comment.