@soulcraft/kits 1.0.0

package/src/kits/reading-tracker.ts

@@ -0,0 +1,368 @@
+/**
+ * @module @soulcraft/kits/kits/reading-tracker
+ * @description Book collection with reading timeline, themes, quotes, and author connections
+ *
+ * Generated from: kits/reading-tracker/kit.json
+ * Do not edit this file directly — edit the source kit.json and re-run `bun run build:kits`.
+ */
+
+import type { SoulcraftKitConfig } from '@soulcraft/kit-schema';
+
+/**
+ * Reading Tracker kit configuration.
+ *
+ * @description Book collection with reading timeline, themes, quotes, and author connections
+ * @see {@link SoulcraftKitConfig}
+ */
+const readingTracker: SoulcraftKitConfig = {
+	"$schema": "https://soulcraft.com/schemas/kit/v2.json",
+	"id": "reading-tracker",
+	"name": "Reading Tracker",
+	"description": "Book collection with reading timeline, themes, quotes, and author connections",
+	"version": "1.0.0",
+	"author": {
+		"name": "Soulcraft Labs",
+		"email": "kits@soulcraft.com",
+		"url": "https://soulcraft.com"
+	},
+	"status": "released",
+	"icon": "📚",
+	"longDescription": "Track your reading journey with a knowledge-graph powered library. Collect books, save memorable quotes, explore themes across your reading history, and discover author bibliographies. Uses Brainy for document, person, content, and concept entity modeling.",
+	"tags": [
+		"books",
+		"reading",
+		"library",
+		"quotes",
+		"authors",
+		"brainy",
+		"sveltekit"
+	],
+	"role": "primary",
+	"type": "soulcraft",
+	"variables": [
+		{
+			"key": "appName",
+			"label": "App Name",
+			"description": "The name of your reading tracker app",
+			"type": "string",
+			"required": true,
+			"example": "my-library"
+		},
+		{
+			"key": "description",
+			"label": "Description",
+			"description": "A short description of your reading journal",
+			"type": "string",
+			"required": false,
+			"example": "My reading journal",
+			"default": "A personal reading tracker and book journal"
+		}
+	],
+	"shared": {
+		"industry": "personal-productivity",
+		"category": "knowledge",
+		"aiExpertise": [
+			"Book recommendations and discovery",
+			"Literary theme analysis",
+			"Reading habit tracking",
+			"Author bibliography research",
+			"Reading goal setting"
+		],
+		"dataModelHints": [
+			"document",
+			"person",
+			"content",
+			"concept"
+		],
+		"suggestions": [
+			{
+				"label": "Add a book",
+				"prompt": "Help me add a new book to my reading tracker"
+			},
+			{
+				"label": "Write a review",
+				"prompt": "Help me write a review of a book I just finished"
+			},
+			{
+				"label": "Find similar books",
+				"prompt": "Recommend books similar to ones I've enjoyed"
+			},
+			{
+				"label": "Set reading goals",
+				"prompt": "Help me set and track my reading goals"
+			},
+			{
+				"label": "Analyze reading habits",
+				"prompt": "Show me statistics and insights about my reading habits"
+			},
+			{
+				"label": "Browse my library",
+				"prompt": "Show me my book collection in the gallery view"
+			}
+		],
+		"dataModel": {
+			"entities": [
+				{
+					"domain": "book",
+					"type": "Document",
+					"description": "A book in the reading collection with status and rating",
+					"products": {
+						"workshop": {
+							"view": "gallery",
+							"icon": "📚"
+						},
+						"academy": {
+							"mapsTo": "learning-artifact",
+							"assessable": true
+						}
+					}
+				},
+				{
+					"domain": "author",
+					"type": "Person",
+					"description": "The author of one or more books in the collection",
+					"products": {
+						"workshop": {
+							"view": "gallery",
+							"icon": "✍️"
+						},
+						"academy": {
+							"mapsTo": "learning-subject",
+							"assessable": false
+						}
+					}
+				},
+				{
+					"domain": "quote",
+					"type": "Concept",
+					"description": "A memorable quote saved from a book",
+					"products": {
+						"workshop": {
+							"view": "gallery",
+							"icon": "💬"
+						},
+						"academy": {
+							"mapsTo": "knowledge-unit",
+							"assessable": true
+						}
+					}
+				},
+				{
+					"domain": "theme",
+					"type": "Concept",
+					"description": "A recurring literary theme appearing across books",
+					"products": {
+						"workshop": {
+							"view": "graph",
+							"icon": "🧵"
+						},
+						"academy": {
+							"mapsTo": "knowledge-unit",
+							"assessable": true
+						}
+					}
+				}
+			],
+			"relationships": [
+				{
+					"from": "book",
+					"to": "author",
+					"verb": "CreatedBy",
+					"description": "Book was written by this author"
+				},
+				{
+					"from": "book",
+					"to": "quote",
+					"verb": "Contains",
+					"description": "Book contains this saved quote"
+				},
+				{
+					"from": "theme",
+					"to": "book",
+					"verb": "Describes",
+					"description": "Theme appears in this book"
+				},
+				{
+					"from": "book",
+					"to": "book",
+					"verb": "References",
+					"description": "Book cites or connects to another book"
+				}
+			]
+		}
+	},
+	"workshop": {
+		"workspaceConfig": {
+			"paradigm": "researcher",
+			"defaultTab": "explore",
+			"defaultView": "graph",
+			"defaultFile": "books/current.md"
+		},
+		"graphGuidance": {
+			"conceptCreation": {
+				"typeMapping": {
+					"book": "document",
+					"author": "person",
+					"quote": "content",
+					"theme": "concept"
+				}
+			},
+			"relationshipPatterns": [
+				{
+					"from": "document",
+					"to": "person",
+					"verb": "createdBy",
+					"description": "Book written by author"
+				},
+				{
+					"from": "document",
+					"to": "content",
+					"verb": "contains",
+					"description": "Book contains quote"
+				},
+				{
+					"from": "concept",
+					"to": "document",
+					"verb": "describes",
+					"description": "Theme appears in book"
+				},
+				{
+					"from": "document",
+					"to": "document",
+					"verb": "references",
+					"description": "Book references another"
+				}
+			],
+			"rules": [
+				"Every book should link to its author",
+				"Quotes should link to source book",
+				"Themes should link to related books"
+			]
+		},
+		"qualityGates": {
+			"fileChecks": [
+				{
+					"path": "package.json",
+					"required": [
+						"svelte",
+						"@sveltejs/kit",
+						"@soulcraft/brainy"
+					],
+					"optional": [
+						"typescript"
+					]
+				},
+				{
+					"path": "src/lib/types.ts",
+					"required": [
+						"Book",
+						"Author"
+					],
+					"optional": [
+						"Quote",
+						"Theme"
+					]
+				}
+			],
+			"projectChecks": [
+				"App starts with npm run dev",
+				"Can add books to library",
+				"Can track reading status",
+				"Can save quotes",
+				"Timeline view shows reading history"
+			],
+			"exportReady": [
+				"No TypeScript errors",
+				"All routes load correctly",
+				"Error handling in place"
+			]
+		},
+		"aiPersona": {
+			"role": "You are a literary companion helping readers track their reading journey, discover connections between books, and build a meaningful personal library.",
+			"expertise": [
+				"Book recommendations",
+				"Literary theme analysis",
+				"Reading habit optimization",
+				"Author research",
+				"Reading goal setting"
+			],
+			"tone": "collaborator"
+		},
+		"difficulty": "intermediate",
+		"templateTier": 4,
+		"templateMetadata": {
+			"runnable": true,
+			"runnableCommand": "npm run dev"
+		},
+		"deploy": {
+			"provider": "cloud-run",
+			"buildCommand": "npm run build",
+			"outputDir": "build",
+			"config": {
+				"port": 3000,
+				"memory": "512Mi"
+			},
+			"oneClickCommand": "gcloud run deploy"
+		},
+		"sampleData": {
+			"entities": [
+				{
+					"type": "document",
+					"name": "The Great Gatsby",
+					"properties": {
+						"year": 1925,
+						"status": "completed",
+						"rating": 5,
+						"dateRead": "2024-06-15",
+						"genre": "Fiction",
+						"description": "A tragic story of wealth, love, and the American Dream in 1920s New York."
+					}
+				},
+				{
+					"type": "person",
+					"name": "F. Scott Fitzgerald",
+					"properties": {
+						"birthYear": 1896,
+						"nationality": "American",
+						"description": "American novelist of the Jazz Age, known for lyrical prose."
+					}
+				},
+				{
+					"type": "concept",
+					"name": "The American Dream",
+					"properties": {
+						"description": "The pursuit of prosperity and success in American society."
+					}
+				}
+			],
+			"relationships": [
+				{
+					"from": "The Great Gatsby",
+					"verb": "createdBy",
+					"to": "F. Scott Fitzgerald"
+				},
+				{
+					"from": "The American Dream",
+					"verb": "describes",
+					"to": "The Great Gatsby"
+				}
+			]
+		}
+	},
+	"academy": {
+		"skillPath": "literary-analysis",
+		"level": "beginner",
+		"learningObjectives": [
+			"Write a structured book review covering argument, evidence, style, and personal evaluation",
+			"Identify recurring themes across multiple books and articulate how they connect",
+			"Extract and contextualise quotes that capture an author's key ideas or literary style",
+			"Build a reading list that systematically covers a topic or expands into new genres"
+		],
+		"assessmentTypes": [
+			"portfolio"
+		],
+		"certificationSlug": "book-reviewer"
+	}
+} satisfies SoulcraftKitConfig;
+
+export default readingTracker;