Skip to content

Getting Started

Setup guides and API usage patterns for the Microlearning Platform.

Guides

Local Development and Testing

Start here. Complete guide covering:

  • Architecture overview (local environment, edge functions)
  • Prerequisites and one-time setup
  • Local environment (development and testing)
  • Serving edge functions with hot reload
  • Seeding test data
  • Running the full test suite
  • Common workflows and troubleshooting

Developer Guide

Comprehensive platform concepts guide:

  • Core vocabulary (Domain, Trail, Concept, Spark, Beacon, Journey)
  • Knowledge graph structure and DAG prerequisites
  • User learning model and progress tracking
  • API usage patterns by use case
  • Integration patterns for frontends, mobile, and server-to-server
  • SDK development

Usage Guide

API usage patterns and request/response examples:

  • Multi-function architecture overview
  • Local vs production URLs
  • Authentication patterns
  • Quick reference for all functions

Quick Start

# 1. Start Docker (required for Supabase)
open -a Docker  # macOS

# 2. Start local Supabase environment
deno task local:start

# 3. Copy and configure environment variables
cp .env.local.example .env.local
# Edit .env.local with values from 'supabase status'

# 4. Seed curriculum data
deno task content:seed

# 5. Serve edge functions (hot reload)
supabase functions serve

# 6. Test it
curl http://127.0.0.1:54321/functions/v1/graph/domains

Local URLs:

  • API: http://127.0.0.1:54321/functions/v1/{function}/*
  • Supabase Studio: http://127.0.0.1:54323
  • Swagger UI: http://127.0.0.1:54321/functions/v1/{function}/doc

Next Steps