Framework Setup Guide

1. Prerequisites

  • Node.js version 18 or later
  • A code editor (VS Code recommended for MCP integration)

2. Install the CLI

npm install -g coursecode

Verify the install:

coursecode --version

3. Create a course project

coursecode create my-course

This scaffolds a new project with starter content, a course config, and all required dependencies.

4. Preview locally

cd my-course
coursecode preview

This starts a local preview server with a simulated LMS player so you can test navigation, interactions, and tracking without uploading to an LMS.

5. Build for your LMS

coursecode build

This produces a universal dist/ folder you can export as SCORM 1.2, SCORM 2004, or cmi5 — or deploy directly to CourseCode Cloud.

6. Optional cloud connection

Framework works fully local/self-managed. Connect CourseCode Cloud later only if you want hosted deployment, analytics, or team collaboration workflows.

coursecode deploy