Documentation

TheSwiftKit/
├── Config/             # AppConfig, Secrets, FeatureFlags
├── Core/
│   ├── DI/             # Dependency injection container
│   ├── Root/           # App entry point, RootView
│   ├── Routing/        # AppRouter with typed routes
│   ├── Theme/          # DesignTokens, AppTheme
│   ├── Services/       # PurchasesService, AIApiClient
│   ├── Analytics/      # AnalyticsService (TelemetryDeck)
│   ├── Notifications/  # NotificationService
│   ├── Logging/        # AppLogger
│   └── Utils/          # AppEvents, extensions
├── Modules/
│   ├── Onboarding/     # 3 onboarding templates
│   ├── Auth/           # SignInView, auth flows
│   ├── Profile/        # ProfileSetupView, avatar upload
│   ├── Paywall/        # PaywallView, subscription UI
│   ├── Demo/           # TestDrive, LocalDataDemo
│   └── Notifications/  # NotificationsDebugView
├── Backend/
│   ├── Protocols/      # Repository protocols
│   ├── Supabase/       # Supabase implementations + SQL
│   └── Python/         # Flask AI backend
└── Resources/          # Assets, Localizable.strings

struct AppConfig {
    static let appName         = "MyApp"
    static let backend: Backend = .supabase   // .supabase or .local
    static let onboardingStyle = .carousel    // .carousel, .highlights, .minimal
    static let layout: HomeLayout = .grid     // .grid or .list

    struct FeatureFlags {
        static let onboarding     = true
        static let authentication = true
        static let paywall        = true
        static let notifications  = true
    }

    struct Legal {
        static let privacyURL = "https://yourapp.com/privacy"
        static let termsURL   = "https://yourapp.com/terms"
    }
}

enum Secrets {
    static let supabaseURL            = "https://xxxxx.supabase.co"
    static let supabaseAnonKey        = "eyJ..."
    static let revenueCatAPIKey       = "appl_..."
    static let telemetryDeckAppID     = "..."
    static let aiBackendBaseURLString = "http://127.0.0.1:5001"
}

// Sign up and sign in are one-liners:
let session = try await supabase.auth.signUp(
    email: email,
    password: password
)

// Session is persisted automatically.
// Profile setup sheet appears after first sign-in.

// Auth flow is automatic:
// 1. Onboarding (if enabled & not completed)
// 2. Sign In (if enabled & not authenticated)
// 3. Profile Setup (if profile is incomplete)
// 4. Main App

// Change this one line to switch onboarding:
static let onboardingStyle = .highlights  // .carousel, .highlights, .minimal

static let defaultPages: [OnboardingPage] = [
    .init(
        title: "Welcome to __APP_NAME__",
        subtitle: "Your personal AI assistant",
        systemImage: "sparkles"
    ),
    .init(
        title: "Smart & Private",
        subtitle: "Your data stays on your device",
        systemImage: "lock.shield"
    ),
    .init(
        title: "Ready to Go",
        subtitle: "Set up in seconds",
        systemImage: "rocket"
    )
]

// The paywall shows automatically when no active entitlement
// is detected. Customize the UI here — the business logic
// is handled by PurchasesService.

struct PaywallView: View {
    @StateObject private var vm = PaywallViewModel()

    var body: some View {
        VStack(spacing: 24) {
            // Hero section
            // Package options (monthly, yearly)
            // Purchase button
            // Restore purchases link
        }
    }
}

# Install dependencies
pip install -r Backend/Python/requirements.txt

# Set your OpenAI key
export OPENAI_API_KEY="sk-..."

# Start the server
python Backend/Python/app.py

# Verify it's running
curl http://127.0.0.1:5001/health
# => { "ok": true }

// Point the iOS app to your backend:
static let aiBackendBaseURLString = "http://127.0.0.1:5001"

// Info.plist includes ATS exceptions for localhost during dev.
// For production, use an HTTPS URL.

static let telemetryDeckAppID = "YOUR_APP_ID"

// That's it. The AnalyticsService initializes automatically
// when this key is present.

// Track custom events anywhere in your app:
AnalyticsService.shared.track("subscription_started", properties: [
    "plan": "yearly",
    "source": "paywall"
])

// Request push notification permissions:
NotificationService.shared.requestPermission()

// Schedule a local notification:
NotificationService.shared.scheduleLocal(
    title: "Time to check in!",
    body: "Open the app to see what's new.",
    delay: 3600  // 1 hour from now
)

struct DesignTokens {
    // Change these two values to re-brand the entire app:
    static let primaryHex = "#8A2BE2"   // Purple
    static let accentHex  = "#FF8A00"   // Orange

    // Computed colors used throughout the app:
    static var primaryColor: Color { Color(hex: primaryHex) }
    static var accentColor: Color  { Color(hex: accentHex) }
}

// Access the theme anywhere in your views:
@Environment(\.appTheme) var theme

// The theme provides consistent styling:
Text("Hello")
    .foregroundColor(theme.primaryColor)
    .font(theme.headlineFont)

// Toggle glass style for a frosted-glass aesthetic:
AppTheme(style: .glass)

// 20 flags total — 7 base + 13 Pro
public var aiPro: Bool
public var widgets: Bool
public var gamification: Bool
// …

// To remove a feature completely:
//   1. set its flag to false in AppConfig.default
//   2. delete its Modules/<Feature>/ folder
//   3. run `xcodegen generate`  →  it is gone, app still builds

let client = AIProStreamClient()

// Tokens arrive live over Server-Sent Events
for try await delta in client.stream(messages: history) {
    message.text += delta
}
// No backend running yet? It falls back to an offline mock stream,
// so the chat always demos.

LLM_PROVIDER=gemini        # or: openai
GEMINI_API_KEY=your_key    # or: OPENAI_API_KEY=your_key
# The /v1/chat/stream SSE endpoint serves both providers.

// Start a Live Activity (Dynamic Island + lock screen)
LiveActivityController.shared.start(
    title: "Order on the way",
    progress: 0.4
)

// End all of them
LiveActivityController.shared.endAll()

// One call awards XP, updates the streak, and unlocks badges
GamificationEngine.shared.recordAction(.completedTask)

// Drop celebration overlays in once — they fire automatically
SomeView()
    .gamificationCelebrations()