fix: Solving PageRoute import and other issues on example app (#3956)

jacobo-dominguez-wgu · web-flow · commit 9e30e8cdb211 · 2026-01-12T09:22:19.000+02:00
* fix: solving pageroute import issue on example app

* fix: lint

* revert: restoring package-lock and reverting frontend platform upgrade

* chore: comments addressed

* docs: updating example app running instructions
diff --git a/README.md b/README.md
@@ -514,10 +514,34 @@ Paragon components can have different behavior in the MFE environment. `example`
 
 Steps to install the `example` app.
 
+To set up the example app with a local Tutor installation, you'll need to configure a Tutor plugin to handle CORS settings
+
+Prerequisites.
+
+Before running the example app, ensure you have a local Tutor installation configured.
+1. Create a new file (i.e. `paragon-example-app.py`) in your tutor plugins folder (`tutor plugins printroot` to get the path).
+2. Add the following content to the paragon-example-app.py file:
+```
+from tutor import hooks
+
+hooks.Filters.ENV_PATCHES.add_item(
+  (
+    "openedx-lms-development-settings",
+    """
+CORS_ORIGIN_WHITELIST.append("http://localhost:8080")
+LOGIN_REDIRECT_WHITELIST.append("http://localhost:8080")
+CSRF_TRUSTED_ORIGINS.append("http://localhost:8080")
+    """
+    )
+)
+```
+3. Enable the plugin: `tutor plugins enable paragon-example-app`
+4. Apply configuration changes: `tutor config save` && `tutor dev restart`
+
+Running the Example App:
 1. `npm install` to install dependencies.
-2. Launch any devstack. It is required for MFE to login into the system and set up configs.
-3. `npm run start-example-mfe` to start the app.
-4. Go to the `example/src/MyComponent.jsx` and use Paragon components inside the MFE environment.
+2. `npm run example:start` to start the app.
+3. Go to the `example/src/MyComponent.jsx` and use Paragon components inside the MFE environment.
 
 ## Semantic Release
 
diff --git a/example/.env.development b/example/.env.development
@@ -1,4 +1,8 @@
-NODE_ENV='development'
-REFRESH_ACCESS_TOKEN_ENDPOINT='http://localhost:18000/login_refresh'
-LMS_BASE_URL='http://localhost:18000'
-ACCESS_TOKEN_COOKIE_NAME='edx-jwt-cookie-header-payload'
+NODE_ENV=development
+REFRESH_ACCESS_TOKEN_ENDPOINT=http://local.openedx.io:8000/login_refresh
+LMS_BASE_URL=http://local.openedx.io:8000
+ACCESS_TOKEN_COOKIE_NAME=edx-jwt-cookie-header-payload
+BASE_URL=http://local.openedx.io:8080
+LOGIN_URL=http://local.openedx.io:8000/login
+LOGOUT_URL=http://local.openedx.io:8000/logout
+CSRF_TOKEN_API_PATH=/csrf/api/v1/token
diff --git a/example/public/index.html b/example/public/index.html
@@ -1,7 +1,7 @@
 <!doctype html>
 <html lang="en-us">
 <head>
-    <title>Example</title>
+    <title>Paragon Example</title>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
 </head>
diff --git a/example/src/index.jsx b/example/src/index.jsx
@@ -1,31 +1,30 @@
-import React from 'react';
-import ReactDOM from 'react-dom';
+import { createRoot } from 'react-dom/client';
 import {
   AppProvider,
   ErrorPage,
-  PageRoute,
+  PageWrap,
 } from '@edx/frontend-platform/react';
 import { APP_INIT_ERROR, APP_READY, initialize } from '@edx/frontend-platform';
 import { subscribe } from '@edx/frontend-platform/pubSub';
 import MyComponent from './MyComponent';
 
 import './index.scss';
 
+const container = document.getElementById('root');
+const root = createRoot(container);
+
 subscribe(APP_READY, () => {
-  ReactDOM.render(
+  root.render(
     <AppProvider>
-      <PageRoute
-        exact
-        path="/"
-        component={MyComponent}
-      />
+      <PageWrap>
+        <MyComponent />
+      </PageWrap>
     </AppProvider>,
-    document.getElementById('root'),
   );
 });
 
 subscribe(APP_INIT_ERROR, (error) => {
-  ReactDOM.render(<ErrorPage message={error.message} />, document.getElementById('root'));
+  root.render(<ErrorPage message={error.message} />);
 });
 
 initialize({
