Skip to content

Commit

Permalink
docs: add installation instructions for tutor to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Talha-Rizwan authored Nov 23, 2023
1 parent e4cb9f0 commit adac984
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,55 @@ This XBlock comes with a Docker test environment ready to build, based on the xb

The XBlock SDK Workbench, including this XBlock, will be available on the list of XBlocks at http://localhost:8000

Installation for tutor
**********************

This method works with [tutor](https://github.com/overhangio/tutor).

First, go to your requirements directory:

```sh
cd $(tutor config printroot)/env/build/openedx/requirements/
```

add the `chatgpt-xblock` repo to the `private.txt`:

```sh
echo "git+https://github.com/edly-io/openedx-cmi5-xblock.git" >> private.txt
```

and build a new image:

```sh
tutor images build openedx
```

In your studio, in your desired course, go to Advanced Settings and add `"openedx_cmi5_xblock"` in the Advanced Module List.


Development
***********

There's no need to build a new image, if you just want to play with the xblock.

First, clone the repo in the requirements directory:

```sh
cd $(tutor config printroot)/env/build/openedx/requirements/
git clone [email protected]:edly-io/openedx-cmi5-xblock.git
```

exec to the lms container and install the XBlock:

```sh
tutor dev exec -it cms bash
cd ../requirements
pip install -e openedx-cmi5-xblock
```

Note: This is not the best practice to develop an XBlock, but it works if you don't want to build dev image.


Translating
*************

Expand Down

0 comments on commit adac984

Please sign in to comment.