brian-smith-tcril/mfe-workshop-2023

Micro-Frontend Micro-Workshop

Welcome to the Micro-Frontend Micro-Workshop repository! This document provides instructions on how to set up your development environment for the interactive portion of the workshop.

More details about the workshop, including the date and time, can be found on the Open edX Conference website and the session page on Sessionize.

Setting up Devstack

To participate in the interactive portion of the workshop, you will need to set up your development environment using the Open edX Devstack. There are two options for setting up Devstack locally:

Option 1: Use a pre-built VM image

This option is faster because all Docker images have already been pulled and the provision scripts have already run. Follow these steps to use this option:

Prerequisites

• A QEMU/KVM-based virtualization solution
  • Linux
    • QEMU (CLI)
    • GNOME Boxes
    • virt-manager
  • Mac
    • QEMU (CLI)
    • UTM

Run a VM using the image

• Download the pre-built VM image from here. (~15GB compressed, ~35GB extracted)
• Verify the image using a checksum from here.
• Set up the VM and forward the ports to access everything running in the VM from your host machine.
  • Linux
  • Mac

Run devstack in the VM

1. Log in to the VM with username: devstack, password: devstack
2. Run devstack

cd code/devstackworkspace
source devstack-venv/bin/activate
cd devstack
make dev.up.lms+studio

Option 2: Install Devstack with Docker

This option involves installing Devstack based on the instructions found at https://github.com/openedx/devstack. Simplified instructions for this workshop can be found here.

Running the Workshop Example Application

• Verify devstack is up and running correctly by going to http://localhost:18000/
• Follow the instructions in the README on https://github.com/brian-smith-tcril/frontend-app-workshop-example/