feat: add example apps (#33)

* fix: wrap getConfig in usePluginSlot

* fix: convert frontend build and paragon to use @openedx scope

* fix: update frontend-platform

Author: jsnwesson

.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)
 ------------------------------------------