@playcademy/vite-plugin 0.1.37 → 0.1.38

package/README.md

@@ -164,6 +164,48 @@ Configuration for the development sandbox server:
 | `enabled` | `boolean` | `false`      | Enable WebSocket server          |
 | `port`    | `number`  | API port + 1 | Custom port for WebSocket server |
 
+### TimeBack Options (`timeback`)
+
+Configuration for TimeBack integration testing during local development:
+
+| Option       | Type                                                    | Default     | Description                                                    |
+| ------------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------- |
+| `timebackId` | `'mock' \| string`                                      | `'mock'`    | TimeBack student ID (defaults to mock when courses configured) |
+| `courses`    | `Record<string, 'mock' \| string>`                      | `undefined` | Course enrollments mapping (`'Subject:Grade'`)                 |
+| `role`       | `'student' \| 'parent' \| 'teacher' \| 'administrator'` | `'student'` | User role for testing different permission levels              |
+
+#### TimeBack Configuration Example
+
+```typescript
+export default defineConfig({
+    plugins: [
+        playcademy({
+            timeback: {
+                // timebackId defaults to 'mock' when courses are configured
+                courses: {
+                    'FastMath:3': 'mock', // Mock enrollment for grade 3
+                    'FastMath:4': 'mock', // Mock enrollment for grade 4
+                    'Science:5': 'real-course-id-123', // Real TimeBack course
+                },
+                role: 'student', // Test as student (default)
+            },
+        }),
+    ],
+})
+```
+
+## CLI Hotkeys
+
+During development, the plugin provides keyboard shortcuts in the terminal:
+
+| Key | Description                                              |
+| --- | -------------------------------------------------------- |
+| `m` | Toggle between platform and standalone modes             |
+| `d` | Recreate sandbox database (resets to fresh seeded state) |
+| `t` | Cycle TimeBack role (student → parent → teacher → admin) |
+
+The `t` hotkey automatically reloads your browser when the role changes, making it easy to test different user permission levels without modifying configuration.
+
 ## Build Output
 
 ### Development Mode
@@ -398,6 +440,28 @@ export default defineConfig(({ mode }) => ({
 }))
 ```
 
+### TimeBack Integration
+
+```typescript
+// Test TimeBack enrollments and role-based features
+export default defineConfig({
+    plugins: [
+        playcademy({
+            timeback: {
+                timebackId: 'mock',
+                courses: {
+                    'FastMath:3': 'mock',
+                    'FastMath:4': 'mock',
+                },
+                role: 'student',
+            },
+        }),
+    ],
+})
+```
+
+During development, press `t` in the terminal to cycle through roles (student → parent → teacher → administrator) and test different permission levels. The browser reloads automatically.
+
 ## Troubleshooting
 
 ### Common Issues