feat: add example apps

.eslintrc.js

@@ -1,4 +1,19 @@
 // eslint-disable-next-line import/no-extraneous-dependencies
-const { createConfig } = require('@edx/frontend-build');
+const { createConfig } = require('@openedx/frontend-build');
 
-module.exports = createConfig('eslint');
+const config = createConfig('eslint');
+
+config.rules = {
+  'import/no-unresolved': ['error', {
+    ignore: ['@edx/frontend-plugin-framework/example*'],
+  }],
+  'import/no-extraneous-dependencies': ['error', {
+    devDependencies: true,
+  }],
+};
+
+config.ignorePatterns = [
+  'example*',
+];
+
+module.exports = config;

README.rst

@@ -26,11 +26,27 @@ for a component that lives in another MFE (the 'Child MFE') to be plugged into a
 
 Getting Started
 ===============
-1. Add Library Dependency
+Add Library Dependency
 -------------------------
 
 Add ``@edx/frontend-plugin-framework`` to the ``package.json`` of both Host and Child MFEs.
 
+Using the Example Apps
+----------------------
+
+1. Run ``npm install`` in the root directory.
+
+2. In separate terminals, run ``npm install`` inside both example app directories (``/example`` and ``/example-plugin-app``).
+
+3. Run ``npm run start`` in both directories.
+
+Alternatively, once the packages are installed in both apps, you can run the apps from the root directory.
+
+1. ``npm run start`` runs the host MFE (``example``)
+
+2. ``npm run start:plugins`` runs the child MFE (``example-plugin-app``)
+
+
 Micro-frontend configuration document (JS)
 ------------------------------------------
 

example-plugin-app/.eslintignore

@@ -0,0 +1 @@
+node_modules

example-plugin-app/.eslintrc.js

@@ -0,0 +1,15 @@
+const { getBaseConfig } = require('@openedx/frontend-build');
+const path = require('path');
+
+const config = getBaseConfig('eslint');
+
+config.rules = {
+  'import/no-extraneous-dependencies': ['error', {
+    packageDir: path.join(__dirname, '..'),
+  }],
+  'import/no-unresolved': ['error', {
+    ignore: ['@edx/frontend-plugin-framework*'],
+  }],
+};
+
+module.exports = config;

example-plugin-app/env.config.js

@@ -0,0 +1,32 @@
+// eslint-disable-next-line no-unused-vars
+const config = {
+  ACCESS_TOKEN_COOKIE_NAME: 'edx-jwt-cookie-header-payload',
+  ACCOUNT_PROFILE_URL: 'http://localhost:1995',
+  ACCOUNT_SETTINGS_URL: 'http://localhost:1997',
+  BASE_URL: 'http://localhost:8081',
+  CREDENTIALS_BASE_URL: 'http://localhost:18150',
+  CSRF_TOKEN_API_PATH: '/csrf/api/v1/token',
+  DISCOVERY_API_BASE_URL: 'http://localhost:18381',
+  PUBLISHER_BASE_URL: 'http://localhost:18400',
+  ECOMMERCE_BASE_URL: 'http://localhost:18130',
+  LANGUAGE_PREFERENCE_COOKIE_NAME: 'openedx-language-preference',
+  LEARNING_BASE_URL: 'http://localhost:2000',
+  LMS_BASE_URL: 'http://localhost:18000',
+  LOGIN_URL: 'http://localhost:18000/login',
+  LOGOUT_URL: 'http://localhost:18000/logout',
+  STUDIO_BASE_URL: 'http://localhost:18010',
+  MARKETING_SITE_BASE_URL: 'http://localhost:18000',
+  ORDER_HISTORY_URL: 'http://localhost:1996/orders',
+  REFRESH_ACCESS_TOKEN_ENDPOINT: 'http://localhost:18000/login_refresh',
+  SEGMENT_KEY: null,
+  SITE_NAME: 'localhost',
+  USER_INFO_COOKIE_NAME: 'edx-user-info',
+  LOGO_URL: 'https://edx-cdn.org/v3/default/logo.svg',
+  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',
+  MFE_CONFIG_API_URL: null,
+  APP_ID: null,
+  SUPPORT_URL: 'https://support.edx.org',
+  PORT: 8081,
+};