Skip to content

Instantly share code, notes, and snippets.

@dancgray
Last active August 9, 2018 14:08
Show Gist options
  • Save dancgray/a84b288b965f6de6173de105879e52aa to your computer and use it in GitHub Desktop.
Save dancgray/a84b288b965f6de6173de105879e52aa to your computer and use it in GitHub Desktop.

Import

You can import course source code built using the adapt framework or exported from the adapt authoring tool. However there are limitations depending on the version of framework and plugins that are installed in the authoring tool you are importing into.

The import feature does not "update" existing courses, a new course will always be create.

Prerequisites

Import requires at least version 0.5.0 of the Adapt Authoring tool.

Importing the Course Source Code

In the authoring tool, import a course by going to the dashboard and clicking "Import source" on the side bar. This will open the course import page.

File: Select the course you want to import by clicking on "Browse". This should be a zip of the course source code (an adapt framework course with all source code and plugins). The package.json, src folder and plugins folder should be in the root of the zip file.

Asset Folder: Enter the folder names where assets that are referenced in the course JSON are stored. Asset folders should be inside the src/course/[lang] folder. By default the import checks for the following folders: assets, images, video, audio. If you enter values for "Asset Folders" you should include all folders that contain assets.

Tags: You can add tags to the course that you are importing. Any tags that you enter will also be applied to all imported assets.

Limitations

  • Plugins that are already installed in the authoring tool will be ignored. They will not be upgraded.
  • In order to prevent duplicates import will check if an asset already exists in the authoring tool before importing.
  • The base authoring tool and course for import framework versions must be compatible (i.e. trying to import a v3 course into an install with framework v2 will not work).
  • The course source files must be in the root of the zip. A zip containing a nested folder will be rejected.
  • If the imported zip contains assets that are not in one of the default folders (assets, images, video, audio) all asset folders must be entered into the Assets folders field.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment