CourseCode logo CourseCode Framework

Framework Setup Guide

1. Prerequisites

  • Node.js version 20.19 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 format-specific dist/ folder and ZIP using the project default. To select a format explicitly, use coursecode build --format scorm1.2, --format scorm2004, --format cmi5, or --format lti.

LTI 1.3 is an integration rather than a static package format and requires a trusted backend for production launches. CourseCode Cloud deployments use a universal build so Cloud can generate the requested LMS download later.

For SCORM-specific guidance, see SCORM course authoring.

6. Connect Cloud when you need it

Framework works locally by default. Connect CourseCode Cloud later if you want hosted deployment, analytics, or team collaboration workflows.

coursecode deploy