Write a guide for developers about how to set up the dev env

[felipemontoya]

The current README just says TBD until we merge some PR. The tutor dir has been done and we can go ahead and write a guide tailored for devs.

[ronakpansuriya]

Hi @felipemontoya
I can take this issue

[felipemontoya]

@Henrrypg @Pavilion4ik would you like to share some of your best practices?

I'll start with my setup.

MOUNTS:
- lms:/full/local/path/my_project/src:/openedx/platform_plugins
- cms:/full/local/path/my_project/src:/openedx/platform_plugins
- /full/local/path/my_project/src/frontend-app-learning
- /full/local/path/my_project/src/frontend-app-authoring

The result of running ls in /full/local/path/my_project/src

-rw-rw-r--  1 fmo fmo    0 Oct 16 14:24 .gitkeep
drwxrwxr-x 10 fmo fmo 4096 Dec 12 16:52 frontend-app-authoring/
drwxrwxr-x  8 fmo fmo 4096 Oct 20 17:51 frontend-app-learning/
drwxrwxr-x 10 fmo fmo 4096 Jan 27 18:10 openedx-ai-extensions/

The three things are the complete repos cloned from github:openedx/xyz

In order to skip having to build frontend images every time, I keep the following env.config.jsx

import { DIRECT_PLUGIN, PLUGIN_OPERATIONS } from '@openedx/frontend-plugin-framework';
import { RedLine, ConfigurableAIAssistance } from '@openedx/openedx-ai-extensions-ui';

const config = {
  ...process.env,
  pluginSlots: {
    'org.openedx.frontend.authoring.course_unit_sidebar.v2': {
      keepDefault: true,
      plugins: [
        {
          op: PLUGIN_OPERATIONS.Insert,
          widget: {
              id: 'ai-assist-button-course-outline-sidebar',
              priority: 60,
              type: DIRECT_PLUGIN,
              RenderWidget: ConfigurableAIAssistance,
          },
        },
      ],
    },
  },
};

export default config;

and also this module.config.js

const path = require('path');

module.exports = {
  localModules: [
    {
      moduleName: '@openedx/openedx-ai-extensions-ui',
      dir: path.resolve(__dirname, '../openedx-ai-extensions/frontend'),
      dist: 'src',
    },
  ],
};

After I turn my tutor env on, I normally go to the learning and or authoring repo and run npm run dev

Other configuration in my local config.yml file includes:

AI_EXTENSIONS:
  anthropic:
    API_KEY: my-key
    MODEL: anthropic/claude-3-haiku-20240307
  deepseek:
    API_BASE: https://router.huggingface.co/v1
    API_KEY: my-key
    MODEL: huggingface/deepseek-ai/DeepSeek-V3.2:novita
  ollama:
    API_BASE: http://ollama:11434
    MODEL: ollama/llama3.2:1b
  openai:
    API_KEY: my-key
    MODEL: openai/gpt-4o-mini
  qwen25:
    API_BASE: http://ollama:11434
    MODEL: ollama/qwen2.5:1.5b
...
PLUGINS:
- openedx-ai-extensions

[Henrrypg]

Hey folks, I've been using the same approach as @felipemontoya

The only thing i would like to add is i needed to install manually the plugin inside the lms and cms container.

# /openedx/platform_plugins/openedx-ai-extensions/backend: pip install -e .

[efortish]

Hello everyone, here is what I did to install the plugin:

1. In the root folder, I have a directory called extra where I ran:
   git clone git+https://github.com/openedx/openedx-ai-extensions.git

2. Inside extra, there is a requirements.txt file with a single line:
   -e ./openedx-ai-extensions/backend

3. It is necessary to mount the plugin folder in config.yml. Add the following:

MOUNTS:
- lms,cms:/home/edunext/edunext/teak/extra:/openedx/extra

And also set this:

AI_EXTENSIONS:
  openai:
    API_KEY: "sk-proj-your-api-key"
    MODEL: "openai/gpt-4o-mini"

PLUGINS:
  - openedx-ai-extensions

4. Run these commands to download and build the plugin image:

pip install git+https://github.com/openedx/openedx-ai-extensions.git
tutor plugins enable openedx-ai-extensions
tutor images build openedx
tutor images build mfe
tutor dev launch

note: make sure you have installed your extra/openedx-ai-extensions instead of using the tutor plugin, I used the tutor plugin only to make the build of the images easier

5. Run these two commands to install the backend in editable mode in both LMS and CMS:

tutor ${ENV} exec lms bash -c "cd /openedx/extra && pip install -r requirements.txt"
tutor ${ENV} exec cms bash -c "cd /openedx/extra && pip install -r requirements.txt"

Note: replace ENV with your Tutor environment (e.g., local, dev).

6. Run the migrations inside the LMS shell:

python manage.py lms migrate openedx_ai_extensions

7. Start the container again:

tutor dev start -d

VOILA ✨

cc. @felipemontoya @Henrrypg @MaferMazu @Pavilion4ik

[MaferMazu]

To complement the @felipemontoya and @efortish configuration, I needed to run npm install in my openedx-ai-extensions/frontend folder so the npm run dev in the mfes works as expected.

The rest looks good ✨