Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/codewithemad/chatgpt-xblock

An OpenedX XBlock to communicate with ChatGPT in your courses.
https://github.com/codewithemad/chatgpt-xblock

Last synced: about 1 month ago
JSON representation

An OpenedX XBlock to communicate with ChatGPT in your courses.

Awesome Lists containing this project

README

        

# ChatGPT for Open edX

This repository contains an Open edX XBlock that brings the power of OpenAI's ChatGPT to your Open edX course.

## Features

- Engaging, dynamic chat interface powered by ChatGPT.
- Customizable prompts and settings to tailor the AI's responses.
- Works seamlessly with the edX ecosystem.

## Installation

This method works with [tutor](https://github.com/overhangio/tutor). feel free to add a method that works with devstack.

First, go to your requirements directory:

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

update the `private.txt` (if you don't have that, create one) and add the `chatgpt-xblock` repo to it:

```sh
echo "git+https://github.com/CodeWithEmad/chatgpt-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 `"chatgpt"` in the Advanced Module List.

![Advanced Module in Open edX Screenshot](./screenshots/Screenshot.png)

## 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]:CodeWithEmad/chatgpt-xblock.git
```

exec to the cms container and install the XBlock:

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

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

## License

This work is licensed under the terms of the [GNU Affero General Public License (AGPL)](https://github.com/overhangio/tutor/blob/master/LICENSE.txt).