adaptlearning/adapt_framework

A toolkit for creating responsive, accessible, multilanguage HTML5 e-learning courses.

Adapt Framework

Adapt is a free and easy to use framework and authoring tool that creates fully responsive, multi-device, HTML5 e-learning content.

Important Note: Adapt no longer supports IE8, 9 & 10. If you need support for those browsers, please use the legacy branch of Adapt instead.

What Does It Do?

The Adapt framework is a toolkit for creating responsive, single-version HTML5 e-learning courses for delivery on a web server or SCORM-compliant learning management system.

We've also created a server-based authoring tool for creating courses using the framework.

Interested? See what Adapt can do.

Features

• Open source, published under the GNU General Public License, and FREE
• HTML5 and CSS3 - now with support for JavaScript ES6-8 and JSX
• Responsive across multiple devices and platforms
• Delivery of courses via SCORM compliant LMS or via web server
• 23 bundled plug-ins, more available through the community
• Meets WAI AA accessibility standards
• Right-To-Left compatibility
• Assessments with support for question banks, randomisation, and customisable feedback
• Step locking and bookmarking
• Multi language and localisation support
• Customisable theme
• Built-in animation effects
• Experience API (xAPI) support via the adapt-contrib-xapi plugin

Got five minutes to spare? Check out our whistle-stop tour of the framework to find out more.

Full Documentation

Visit the wiki for full documentation, including installation, course authoring, developer guides, and other information.

Communication

• Twitter: @AdaptLearning
• Gitter
• Community Site
• Technical Forum
• Bugs / Feature Requests
• Responsive e-Learning Forum

Contributing to Adapt

See Contributing to the Adapt Framework.

Troubleshooting, Bugs, and Feedback

• For help with troubleshooting, visit the Technical Discussion Forum.
• To report a bug, please submit an issue via Github Issues.
• To provide feedback, please use GitHub Issues.

License

Adapt is licensed under the GNU General Public License, Version 3.

Requirements

Node >=16 is required for the grunt tasks to run as needed

adapt_framework's Issues

CCR-LF-004: Able to modify high-level padding and spacing settings

M 1.0

LRN-LF-014: Able to increase the font size of text

M 1.0
Not necessary functional, e.g. via browser

DEV-CLI-015: Able to register new extensions with the local installation of the Adapt framework

M 1.0
Covered by putting it into the right folder

DEV-CLI-001: Able to run an installation script for Adapt Framework and CLI

M 1.0

DEV-CLI-013: Able to CRUD extension

M 1.0

DEV-CLI-004: Able to populate the content (JSON and assets)

M 1.0
This is a manual task in text editor

adapt.json to simplify setup procedure?

After installing one theme the adapt.json file is created, if not already planned I think we need to include adapt.json in the core so out of the box the default theme and displaying a text component is part of the kit?

{
    "dependencies": {
        "adapt-contrib-vanilla": "0.0.0",
        "adapt-contrib-text": "0.0.0"
    }
}

This would allow the user after downloading the source to run adapt install and all required dependancies would download too. It would make it much easier for users getting started. I could then look at including this into the documentation if required on the wiki page.

Alternatively if rejected I can include documentation on how to install each component.

LRN-COM-003: Able to view the content associated to a component in a suitable format according to different device types

M 1.0

DEV-CLI-011: Able to CRUD menu

M 1.0

CCR-LF-012: Able to choose background images for articles

M 1.0

DEV-CLI-010: Able to CRUD theme

M 1.0
A basic theme must be packaged
Creating new theme not necessarily required as basic theme is supplied

Navigation needs higher z-index

Adjust z-index in core less files

LRN-NAV-001: Able to view a navigation menu

M 1.0

Fixes to core functionality

• Updated pageView ready functions
• Updated the menuView

CCR-LF-003: Able to modify basic theme colour settings

M 1.0

DEV-CLI-020: Able to add plug-ins to the adapt.json file (to simplify the installation process)

S 1.0

Mediator

What do people think?
https://github.com/adaptlearning/adapt_framework/tree/prototype/mediator

CCR-LF-013: Able to insert a transparent placeholder which allows learners to see the background graphic

M 1.0
via Blank component

Add ``_classes`` attribute to each view

bower missing from package.json

Running through the 'getting started' page - I got stuck trying to build the project for the first time as bower wasn't installed as part of the local 'npm install', meaning I had to install bower manually to get past this step.

LRN-LF-003: Able to see imagery as part of the course

M 1.0

DEV-CLI-014: Able to configure plug-ins by populating JSON

M 1.0

DEV-CLI-006: Able to build the course with source-mapping turned on

M 1.0

LRN-ART-001: Able to view the title and body of an article

M 1.0

DEV-CLI-021: Able to push the newly installed plug-in into the correct folder (e.g. components, themes etc)

M 1.0

DEV-CLI-012: Able to CRUD component

M 1.0

DEV-CLI-019: Able to install all core bundle plug-ins in the adapt.json file in one command line

M 1.0

LRN-PG-001: Able to view a page

M 1.0

DEV-CLI-008: Able to invoke unit tests

M 1.0
Quality enabler

CCR-LF-005: Able to set standard font face for the course

M 1.0

LRN-BLK-001: Able to view the title and body of a block

M 1.0

DEV-CLI-009: Able to launch the course locally

M 1.0
Via grunt command

CCR-CSTR-001: Able to CRUD a page

M 1.0

DEV-CLI-005: Able to publish (build) the course

M 1.0

CCR-LF-011: Able to choose background images for pages

M 1.0

Change ``init`` to ``preRender`` & update require syntax

Change init to preRender to keep inline with the events being fired off and to stop naming of 'initialize' and 'init' being too close.

Also to change over to commonJS style syntax to stop modules being confused with each other.

Bug with pageView and object rendering

Due to the way that parent elements render their children we are unable to stop the hotgraphic rendering when it should render a narrative instead on smaller devices. To fix this issue I suggest changing back the render function into the views. This way we can stop the components rendering and swapping out. This needs to be reflected in the router, adaptView.

Also each parent view should pass down it's parent container to each of it's children. This enables views to remove and attach whenever then need to

LRN-PG-002: Able to view persistent navigation on a page

M 1.0

CCR-CSTR-001: Able to CRUD a page

M 1.0

CCR-LF-006: Able to set the standard font size for the course

M 1.0

DEV-CLI-007: Able to invoke minification as part of the build

M 1.0

LRN-LF-005: Able to see alternative text for content images used in the course

M 1.0
Alt attributes

CCR-LF-009: Able to choose background image for the entire course

M 1.0

DEV-CLI-018: Able to install/uninstall a plug-in into a local course/project

M 1.0

LRN-NAV-004: Able to navigate up a level / to the menu

M 1.0

LRN-LF-001: Able to view a course, which looks & feels nice and reflects a brand and design

M 1.0

LRN-LF-002: Able to view a single course on multiple types of devices with different viewports

M 1.0

LRN-NAV-002: Able to navigate to a page

M 1.0

LRN-LF-017: Able to view the content in an available font in case a specific font is unavailable

M 1.0

LRN-COM-001: Able to see the components which contain the content in a meaningful order

M 1.0