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

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
brian-smith-tcril authored Jan 25, 2023
1 parent 7f4ed92 commit 316a1d3
Showing 1 changed file with 28 additions and 14 deletions.
42 changes: 28 additions & 14 deletions tutor-contrib-library-authoring-mfe/README.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,30 @@
library_authoring_mfe plugin for `Tutor <https://docs.tutor.overhang.io>`__
library_authoring_mfe plugin for `Tutor <https://docs.tutor.overhang.io>`_
===================================================================================

Installation
------------

Follow these instructions to enable this microfrontend:

1. Install `tutor nightly <https://github.com/overhangio/tutor/tree/nightly>`_: ``pip install -e 'git+https://github.com/overhangio/tutor.git@nightly#egg=tutor'``
2. Install `tutor-mfe nightly <https://github.com/overhangio/tutor-mfe/tree/nightly>`_: ``pip install -e 'git+https://github.com/overhangio/tutor-mfe.git@nightly#egg=tutor-mfe'``
3. Install `tutor-contrib-blockstore <https://github.com/brian-smith-tcril/tutor-contrib-blockstore/>`_: ``pip install -e 'git+https://github.com/brian-smith-tcril/tutor-contrib-blockstore#egg=tutor-contrib-blockstore'``
4. Install this plugin: ``pip install -e 'git+https://github.com/brian-smith-tcril/frontend-app-library-authoring.git@tutor-prod#egg=tutor-contrib-library-authoring-mfe&subdirectory=tutor-contrib-library-authoring-mfe'``
5. Enable the blockstore plugin: ``tutor plugins enable blockstore``
6. Enable this plugin: ``tutor plugins enable library_authoring_mfe``
7. Save the tutor config: ``tutor config save``
8. Build mfe image: ``tutor images build mfe`` (if you have trouble here you may need to run it with ``--no-cache``)
9. Launch tutor: ``tutor local launch``
* Install `tutor nightly <https://github.com/overhangio/tutor/tree/nightly>`_: ``pip install -e 'git+https://github.com/overhangio/tutor.git@nightly#egg=tutor'``
* Install `tutor-mfe nightly <https://github.com/overhangio/tutor-mfe/tree/nightly>`_: ``pip install -e 'git+https://github.com/overhangio/tutor-mfe.git@nightly#egg=tutor-mfe'``
* To use blockstore with `minio <https://min.io/>`_

* Install `tutor-minio <https://github.com/overhangio/tutor-minio>`_ nightly ``pip install -e 'git+https://github.com/overhangio/tutor-minio.git@nightly#egg=tutor-minio'``
* Enable minio plugin: ``tutor plugins enable minio``
* Install `tutor-contrib-blockstore-minio <https://github.com/brian-smith-tcril/tutor-contrib-blockstore-minio/>`_: ``pip install -e 'git+https://github.com/brian-smith-tcril/tutor-contrib-blockstore-minio#egg=tutor-contrib-blockstore-minio'``
* Enable the blockstore_config_minio plugin: ``tutor plugins enable blockstore_config_minio``

* To use blockstore with django :code:`FileSystemStorage`

* Install `tutor-contrib-blockstore-filesystem <https://github.com/brian-smith-tcril/tutor-contrib-blockstore-filesystem/>`_: ``pip install -e 'git+https://github.com/brian-smith-tcril/tutor-contrib-blockstore-filesystem#egg=tutor-contrib-blockstore-filesystem'``
* Enable the blockstore_config_filesystem plugin: ``tutor plugins enable blockstore_config_filesystem``

* Install this plugin: ``pip install -e 'git+https://github.com/brian-smith-tcril/frontend-app-library-authoring.git@tutor-prod#egg=tutor-contrib-library-authoring-mfe&subdirectory=tutor-contrib-library-authoring-mfe'``
* Enable this plugin: ``tutor plugins enable library_authoring_mfe``
* Save the tutor config: ``tutor config save``
* Build mfe image: ``tutor images build mfe`` (if you have trouble here you may need to run it with ``--no-cache``)
* Launch tutor: ``tutor local launch``

If you want to run this MFE in
`development mode <https://github.com/overhangio/tutor-mfe/#mfe-development>`_
Expand All @@ -26,10 +36,14 @@ If you want to run this MFE in

Setup
-----
1. Ensure you have created a user: https://docs.tutor.overhang.io/local.html#creating-a-new-user-with-staff-and-admin-rights
2. Ensure you have created an organization: http://studio.local.overhang.io/admin/organizations/organization/
* Ensure you have created a user: https://docs.tutor.overhang.io/local.html#creating-a-new-user-with-staff-and-admin-rights
* Ensure you have created an organization: http://studio.local.overhang.io/admin/organizations/organization/
* If you're using minio

* Log in to the `minio Web UI <http://minio.local.overhang.io>`_ (`instructions to find credentials <https://github.com/overhangio/tutor-minio#web-ui>`_)
* Create a **public** bucket for blockstore (the default configuration expects the bucket to be named :code:`blockstore`)

Usage
-----
1. Log in to studio: http://studio.local.overhang.io/home/
2. Click on the libraries tab
* Log in to studio: http://studio.local.overhang.io/home/
* Click on the libraries tab

0 comments on commit 316a1d3

Please sign in to comment.