Skip to content
This repository has been archived by the owner on Jul 18, 2024. It is now read-only.

Latest commit

 

History

History
284 lines (184 loc) · 11.9 KB

README.rst

File metadata and controls

284 lines (184 loc) · 11.9 KB
Raw

frontend-app-library-authoring

Build Status Codecov license

Please tag @edx/fedx-team on any PRs or issues. Thanks.

Purpose

This is the Library Authoring micro-frontend, currently under joint development by edX and OpenCraft under the auspices of BD-14.

It is being built to provide an updated library authoring experience, with improved tools for both randomized content blocks and the ability to directly reference library content blocks in existing courses. This experience is to be powered by the new blockstore storage engine.

Note

A content library is a collection of learning components (XBlocks) designed for re-use in other contexts. Components in a content library can be integrated into a course, used as a problem bank for randomized exams, and/or shown to learners directly for à la carte learning.

Getting Started

Tutor Installation

Refer to the tutor-contrib-library-authoring-mfe plugin for instructions on how to deploy this using Tutor.

Cloning and Startup

1. Clone your new repo:

  ``git clone https://github.com/openedx/frontend-app-library-authoring.git``

2. Use node v18.x.

  The current version of the micro-frontend build scripts support node 18.
  Using other major versions of node *may* work, but this is unsupported.  For
  convenience, this repository includes an .nvmrc file to help in setting the
  correct node version via `nvm <https://github.com/nvm-sh/nvm>`_.

3. Install npm dependencies:

  ``cd frontend-app-library-authoring && npm ci``

4. Start the dev server:

  ``npm start``

Devstack Installation

Follow these steps to provision, run, and enable an instance of the Library Authoring MFE for local development via the official Open edX devstack.

  1. To start, clone the devstack repository as a child of an arbitrary ~/workspace/ directory.

    mkdir -p ~/workspace/
cd ~/workspace/
git clone https://github.com/openedx/devstack.git

  2. Configure default services and setup devstack

    Note: If you are planning on running frontend-app-library-authoring locally outside of docker, skip this step to avoid address conflicts.

    Create a devstack/options.local.mk file with the following contents:

    DEFAULT_SERVICES ?= \
credentials+discovery+ecommerce+edx_notes_api+forum+frontend-app-publisher+frontend-app-gradebook+lms+studio+frontend-app-library-authoring

    This adds frontend-app-library-authoring to the list of services the devstack will provision and enable automatically.

    During the devstack setup process, running make dev.clone will automatically clone this repository as a the sibling to the ~/workspace/devstack/ directory.

    Once devstack provisioning is complete, check that this MFE's container is running by executing the following from inside ~/workspace/devstack:

    make dev.ps | grep library-authoring

    You should see the container with status "Up", exposing port 3001:

    edx.devstack.frontend-app-library-authoring   docker-entrypoint.sh bash  ...   Up       0.0.0.0:3001->3001/tcp

  3. Proceed with the setup of the devstack as described in the README's Getting Started section.

  4. Now set up blockstore. Blockstore can be simply enabled by using the waffle SWITCH (NOT FLAG) using Blockstore's Using in Production Or Locally section. If you wish to modify devstack, follow the additional steps outlined in its README's Development in Devstack section.

    This will setup the blockstore container, configure the LMS and the CMS to accept requests from it (and vice-versa), create a "Devstack Content Collection" in blockstore, and finally create a sample "DeveloperInc" organization in the LMS that can be used to create content.

    There's no need to log in to blockstore in your web browser directly, so feel free to skip the last step.

  5. In a Studio shell, enable the ENABLE_LIBRARY_AUTHORING_MICROFRONTEND feature flag:

    make dev.shell.cms
vim /edx/etc/studio.yml
---
FEATURES:
    ENABLE_LIBRARY_AUTHORING_MICROFRONTEND: true

    Exit the shell and restart Studio so changes take effect:

    make dev.restart-container.cms

  6. On a browser, go to http://localhost:18010/admin/waffle/flag/, log in as an admin (such as the sample user edx) and create a studio.library_authoring_mfe waffle flag, and enabling it for everyone.

    This will make it so that clicking on the Libraries tab in Studio will take you to the Library Authoring MFE as a logged-in user.

    ./docs/images/screenshot_mfe.png

  7. Once at the Library Authoring page, to create a blockstore-based library click on the "New Library" button on the top right-hand corner, filling in Title, Organization, and ID, and making sure to select the "Complex (beta)" type. (In contrast, creating a "Legacy" library would have it backed by modulestore.)

    ./docs/images/screenshot_creating.png

  8. Finally, adding components is done by selecting the desired type under the "Add New Component" heading at the bottom of the list of existing ones. You can edit them by clicking on the corresponding "Edit" button, once they're visible in the list.

    ./docs/images/screenshot_adding_components.png

Project Structure

The source for this project is organized into nested submodules according to the ADR Feature-based Application Organization.

Build Process Notes

Production Build

The production build is created with npm run build.

Internationalization

Please see edx/frontend-platform's i18n module for documentation on internationalization. The documentation explains how to use it, and the How To has more detail.

Known Issues

  • [SE-3989] There is a fatal blockstore integration test failure that is likely triggering search bugs, related to edx/edx-search#104.
  • Some component types, such as text (HTML), videos and CAPA problems, can be added to libraries but cannot be edited using Studio's visual authoring tools. The issue manifests itself as either an error message when clicking the "Edit" tab of such a block (particularly with the HTML block) or malformed rendering (for the video block). This is a limitation of Studio, not this MFE, and work is under way to address the issue accordingly. (It is still possible to edit a block with OLX, however.)
  • The current component editing flow is a direct port of ramshackle with only minor improvements. It is pending an UX audit and internationalization, among other things.
  • Users with view only access are able to see the 'User Access' menu item, despite the fact it will just kick them back to the detail view.
  • The library isn't always updated between when it is changed in the edit view/create view and when you return to the authoring view. So sometimes you may need to refresh after changing a library to get the right authoring view.
  • Styling needs love: to speed up development, we we originally relied on the old edX theme as provided by Paragon to match Studio's look. That was removed on [email protected], so many components are now visually broken. We need to go back to the (literal, in this case) drawing board.
  • We should take frontend-app-learning's lead as far as test tooling is concerned (remove enzyme, use axios-mock-adapter, etc). This should help avoid the handful of non-fatal console errors that appear when running tests.
  • Test coverage can, and should, be improved.

Development Roadmap

The following is a list of current short-term development targets, in (rough) descending order of priority:

  • [Studio enhancement] Implement embeddable visual editors for the HTML, video, and problem blocks
  • [Studio enhancement] An improved "source from library" workflow that will let course authors include library content in existing courseware.
  • [MFE enhancement] Iteration and refinement of the library authoring/publishing flow.
  • [MFE bugfix] Fixing the Known Issues that are not explicitly listed in this Roadmap.

Getting Help

If you're having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.

Our real-time conversations are on Slack. You can request a Slack invitation, then join our community Slack workspace. Because this is a frontend repository, the best place to discuss it would be in the #wg-frontend channel.

For anything non-trivial, the best path is to open an issue in this repository with as many details about the issue you are facing as you can provide.

https://github.com/openedx/frontend-app-library-authoring/issues

For more information about these options, see the Getting Help page.

Contributing

Contributions are very welcome. Please read How To Contribute for details.

This project is currently accepting all types of contributions, bug fixes, security fixes, maintenance work, or new features. However, please make sure to have a discussion about your new feature idea with the maintainers prior to beginning development to maximize the chances of your change being accepted. You can start a conversation by creating a new issue on this repo summarizing your idea.

The Open edX Code of Conduct

All community members are expected to follow the Open edX Code of Conduct.

License

The code in this repository is licensed under the AGPLv3 unless otherwise noted.

Please see LICENSE for details.

Reporting Security Issues

Please do not report security issues in public. Please email [email protected].