e3b692b9f2
* fix: fixing broken linter script and linting The linter script in package.json didn’t specify which files to lint, so it never linted anything. As soon as I fixed the script line, there was suddenly a ton of stuff that needed linting. This fixes the script and cleans up all the things that needed linting. The vast majority were formatting auto-fixes in VSCode for me. * fix: setting NODE_ENV to production in .env Without this change, the NODE_ENV comes through as “null” (a string!) in the app. This causes a number of third party dependencies like React and Redux to potentially go into development mode, slowing them down, or to not realize they’re in production mode, causing them to throw some warnings. * style: some additional linting * feat: upgrading to modern paragon and a brand package This commit updates the app from Paragon 7 to 12 and fixes the breaking changes in between. Mostly small changes to Button and Dropdown, as well as using “container” instead of “container-fluid” to preserve the page’s width as closely as possible. It also adds the brand package, which is why it’s a feature. Using the brand package allows the MFE to be rebranded by using an npm alias to override the source of the brand. * test: fixing test snapshots that failed when updating paragon The test snapshots got a bit out of date when updating paragon. Also removing an unncessary “type” from Dropdown.Toggle which does nothing. - container has been replaced by container-fluid - The Button component is a different implementation, which adds slightly different properties to the rendered button. i.e., onKeyDown and disabled, but doesn’t add the id or onBlur. - The Dropdown doesn’t render its contents until it’s opened, which is why “Upload Photo” and “Remove” are no longer in the snapshot. - * build: bumping paragon to 13 * fix: fixing broken test snapshot btn-outline is definitely not a correct button type. * fix: using the ‘size’ property on Button * fix: updating dependencies We needed to upgrade paragon to 13.1.2 to fix a transpilation issue that was causing ES6 code to be included in the build artifact. All other upgrades here were attempts at fixing that, but they’re all also perfectly valid and good to update, so I left them. babel-polyfill has been replaced by including core-js and regenerator-runtime. Upgrading frontend-build fixed an issue with eslint configuration that emerged during the other upgrades. * fix: switch back to container-fluid We want to leave it as container-fluid and solve the max width problem through paragon. * style: cleanup and formatting of SCSS Also removing an unnecessary variant of primary on a button. * test: fix broken snapshot test
|Build Status| |Codecov| |npm_version| |npm_downloads| |license| |semantic-release| frontend-app-profile ==================== This is a micro-frontend application responsible for the display and updating of user profiles. Please tag **@edx/arch-fed** on any PRs or issues. When a user views their own profile, they're given fields to edit their full name, location, primary spoken language, education, social links, and bio. Each field also has a dropdown to select the visibility of that field - i.e., whether it can be viewed by other learners. When a user views someone else's profile, they see all those fields that that user set as public. ---------- Development ----------- Start Devstack ^^^^^^^^^^^^^^ To use this application `devstack <https://github.com/edx/devstack>`__ must be running and you must be logged into it. - Start devstack - Log in (http://localhost:18000/login) Start the development server ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ In this project, install requirements and start the development server by running: .. code:: bash npm install npm start # The server will run on port 1995 Once the dev server is up visit http://localhost:1995/u/staff. ---------- Configuration and Deployment ---------------------------- This MFE is configured via node environment variables supplied at build time. See the .env file for the list of required environment variables. Example build syntax with a single environment variable: .. code:: bash NODE_ENV=production ACCESS_TOKEN_COOKIE_NAME='edx-jwt-cookie-header-payload' npm run build For more information see the document: `Micro-frontend applications in Open edX <https://edx.readthedocs.io/projects/edx-developer-docs/en/latest/micro-frontends-in-open-edx.html>`__. ---------- Notes ----- The production Webpack configuration for this repo uses `Purgecss <https://www.purgecss.com/>`__ to remove unused CSS from the production css file. In ``webpack.prod.config.js`` the Purgecss plugin is configured to scan directories to determine what css selectors should remain. Currently the src/ directory is scanned along with all ``@edx/frontend-component*`` node modules and ``@edx/paragon``. **If you add and use a component in this repo that relies on HTML classes or ids for styling you must add it to the Purgecss configuration or it will be unstyled in the production build.** .. |Build Status| image:: https://api.travis-ci.org/edx/frontend-app-profile.svg?branch=master :target: https://travis-ci.org/edx/frontend-app-profile .. |Codecov| image:: https://img.shields.io/codecov/c/github/edx/frontend-app-profile :target: https://codecov.io/gh/edx/frontend-app-profile .. |npm_version| image:: https://img.shields.io/npm/v/@edx/frontend-app-profile.svg :target: https://www.npmjs.com/package/@edx/frontend-app-profile .. |npm_downloads| image:: https://img.shields.io/npm/dt/@edx/frontend-app-profile.svg :target: https://www.npmjs.com/package/@edx/frontend-app-profile .. |license| image:: https://img.shields.io/npm/l/@edx/frontend-app-profile.svg :target: @edx/frontend-app-profile .. |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