Ship to LMS checklist¶

Appendix only. Use LMS Go-Live first. This page is a one-page quick reference.

Appendix — read LMS Go-Live first

This one-page checklist is a quick reference only. For the decision tree, shared steps, and troubleshooting, start with LMS Go-Live.

One-page checklist for taking a scaffolded LessonKit course from local preview to a working LMS upload. Complete Getting started in 5 minutes first if you have not previewed locally yet.

When something breaks

Use the troubleshooting decision tree or FAQ.

Before you start¶

Requirement	Details
Node.js	See Prerequisites — decision table
Project	From `npx @lessonkit/cli init` with `npm run dev` working
IDs	`courseId`, `lessonId`, and every `checkId` match between React and `lessonkit.json`

Checklist¶

1. Configure the LMS bridge¶

In src/courseConfig.ts:

lxpack: {
  bridge: "auto",
  allowedParentOrigins: ["https://your-lms.example"],
},

Development builds allow bridge: "auto" without an allowlist; production builds require allowedParentOrigins. See LXPack bridge reference.

2. Configure production runtime¶

Choose one path:

Path	Steps
Production delivery	Copy `.env.example` → `.env`; set `VITE_ANALYTICS_URL` and `VITE_XAPI_PROXY_URL`; wire observability hooks in `courseConfig.ts` (see comments there)
First smoke test only	Temporarily set `tracking: { enabled: false }` and `xapi: { enabled: false }` in `courseConfig.ts`

Details: LMS Go-Live · Production checklist (appendix)

3. Set activity IRI (xAPI / cmi5 only)¶

Replace the example.com placeholder in lessonkit.json → course.tracking.xapi.activityIri with an HTTPS IRI for your organization.

4. Build and package¶

npm run build
npm run package:scorm12   # or scorm2004, standalone, xapi, cmi5

Note the ZIP path the CLI prints (default: .lxpack/course/.lxpack/out/course-scorm12.zip).

5. Upload and verify in LMS¶

Upload the ZIP to your LMS staging environment.
Launch as a learner; complete the quiz or assessment.
Confirm completion/score appears in the LMS gradebook or report.
If completion is missing, verify window.parent.lxpackBridge.v1 in browser devtools and re-check allowedParentOrigins.

6. Go-live (production)¶

Before learner-facing deployment:

Real analytics/xAPI transports wired (no console-only sinks)
All required observability hooks configured
Pin aligned @lessonkit/* versions in package.json
Run through deployment guide for CORS/proxy setup
Optional: LRS operations for statement monitoring

Deep dives¶

Topic	Guide
Canonical go-live guide	LMS Go-Live
Production guardrails	Production checklist
Proxy and CORS	Deployment guide
CLI flags and targets	Packaging and CLI
LMS format requirements	LMS compatibility
Export parity testing	Export parity