Skip to content
school-footprint

Quick Start

Quick Start

Section titled “Quick Start”

Install

Section titled “Install”
Terminal window
npm install school-footprint footprintjs

Create a Platform

Section titled “Create a Platform”
import {
  createSchoolPlatform,
  createMemoryProfileStore,
  createStubRepository,
} from "school-footprint";


const platform = createSchoolPlatform({
  profileStore: createMemoryProfileStore([
    { unitId: "dance-1", profileType: "dance", createdAt: "2024-01-01" },
  ]),
  repository: createStubRepository("my-app"),
});

Run a Flow

Section titled “Run a Flow”
const ctx = { tenantId: "t1", campusId: "c1", unitId: "dance-1" };


const result = await platform.executeServiceFlow(ctx, "enroll-student", {
  firstName: "Alice",
  lastName: "Smith",
});


console.log(result.status);     // "ok"
console.log(result.narrative);  // Step-by-step trace

What You Get

Section titled “What You Get”
  • 8 service flows (enrollment, scheduling, attendance, grading, fees, …)
  • 5 school types with automatic terminology, theme, and strategy switching
  • Full tracing — every stage records reads, writes, and narrative
  • 428 tests — all run without a database

Next Steps

Section titled “Next Steps”