Skip to content

Technical Documentation

This section provides a comprehensive technical reference for the SisterShield platform. It is intended for developers, maintainers, and evaluators who need to understand how the system is built, how its features work, and how to set up a development environment.

Quick Reference

TechnologyVersionPurpose
Next.js (App Router)14.2.21Full-stack React framework
TypeScript5.7.2Type-safe language
React18.3.1UI component library
PostgreSQLRelational database
Prisma6.2.1ORM and database toolkit
NextAuth4.24.11Authentication (JWT strategy)
next-intl3.26.3Internationalization (ko-KR, en-US)
Tailwind CSS3.4.17Utility-first CSS framework
shadcn/ui (Radix UI)Accessible component primitives
Lucide React0.469.0Icon library
Anthropic SDK0.39.0Claude Sonnet LLM integration
OpenAI SDK4.77.0GPT-4o and DALL-E 3 integration
Playwright1.40.0End-to-end testing
Zod3.24.1Runtime schema validation
bcryptjs2.4.3Password hashing

Section Map

System Architecture Overview

High-level architecture, component diagram, data flow, and how the major subsystems connect.

Key Application Flows

Sequence diagrams for authentication, course creation, course play, submission review, and the Quick Exit safety mechanism.

Feature Map

A table mapping every major feature to its code location, description, and implementation status.

How to Use SisterShield

Role-based user guide covering Student, Teacher, and Admin workflows.

Stack & Setup Guide

Prerequisites, installation steps, environment variables, and development commands.

Privacy & Safety Controls

Data lifecycle, authentication details, Quick Exit behavior, AI safety constraints, and privacy considerations.

Semantic Design Tokens

The token architecture, CSS custom properties, Tailwind configuration, CTA styling rules, and anti-creep guidelines.

AI Prompting & Disclosure

How AI is used across the platform, provider abstraction, safety controls, and ethical disclosure.

Course Generator LLM Prompt Spec

The full system prompt, reference standards, output structure, few-shot examples, and safety strategy for AI-generated courses.

Source Code Layout

src/
app/
[locale]/
(auth)/ Login, Register pages
(dashboard)/ Dashboard, Courses, Submissions, Progress, Settings
api/ REST API routes
components/
ui/ shadcn/ui components
layout/ Header, Sidebar, Footer, LocaleSwitcher
twine/ TwinePlayer (iframe renderer)
hero/ Landing page components
safety/ QuickExit, GetHelp
courses/ CourseCard, ImagePromptPanel
lib/
prisma.ts Database client singleton
auth.ts NextAuth configuration
analytics.ts Event tracking
storage/ File storage abstraction (local, future S3)
twine/ Parser, compiler, injector, builder, renderer, error detection
i18n/ Locale config, navigation, request handling
llm/ LLM client, story generation, translation, error fixing, image prompts
hooks/ useProgress and other custom hooks
messages/ en-US.json, ko-KR.json (translation strings)
prisma/
schema.prisma Database schema
seed.ts Seed script for test data