@bhooai/nexus-examples 2.0.0

package/src/index.ts

@@ -0,0 +1,99 @@
+/**
+ * Examples registry. Each entry describes one example:
+ *   - id: kebab-case
+ *   - label: display name in `nexus init --interactive` list
+ *   - description: one liner
+ *   - packagesDemoed: which @bhooai/nexus-* the example exercises
+ *   - portsUsed: hint only; real ports are allocated by `nexus init` / `nexus add`
+ *   - files: relative to examples/<id>/ — files laid down on top of the base scaffold
+ *   - envRequired: optional env vars the example needs (e.g. API keys)
+ */
+
+export interface ExampleMeta {
+  id: string;
+  label: string;
+  description: string;
+  packagesDemoed: string[];
+  envRequired?: string[];
+  portsUsed?: number;
+}
+
+export const EXAMPLES: ExampleMeta[] = [
+  {
+    id: 'empty',
+    label: 'Empty project',
+    description: 'Bare scaffold — start your app here.',
+    packagesDemoed: ['nexus-core'],
+  },
+  {
+    id: 'chat',
+    label: 'Chat',
+    description: 'Realtime chat rooms with presence and typing indicators.',
+    packagesDemoed: ['nexus-core', 'nexus-realtime', 'nexus-auth'],
+  },
+  {
+    id: 'video-call',
+    label: 'Video call',
+    description: '1:1 WebRTC call with signaling via WS and mediasoup SFU.',
+    packagesDemoed: ['nexus-core', 'nexus-realtime'],
+  },
+  {
+    id: 'checkout',
+    label: 'Checkout',
+    description: 'Razorpay+PayPal payment flow with mailables and webhooks.',
+    packagesDemoed: ['nexus-core', 'nexus-payments', 'nexus-email', 'nexus-data'],
+    envRequired: ['NEXUS_PAYMENTS_RAZORPAY_KEY_ID', 'NEXUS_PAYMENTS_RAZORPAY_KEY_SECRET'],
+  },
+  {
+    id: 'livestream',
+    label: 'Livestream',
+    description: 'One broadcaster, multiple viewers via mediasoup + chat overlay.',
+    packagesDemoed: ['nexus-core', 'nexus-realtime'],
+  },
+  {
+    id: 'ai-chat',
+    label: 'AI chat',
+    description: 'Streaming LLM chat via nexus-ai-client + provider switching.',
+    packagesDemoed: ['nexus-core', 'nexus-ai-client', 'nexus-realtime'],
+  },
+  {
+    id: 'saas-starter',
+    label: 'SaaS starter',
+    description: 'Auth + billing + teams + admin tab. Real SaaS skeleton.',
+    packagesDemoed: ['nexus-core', 'nexus-auth', 'nexus-data', 'nexus-payments', 'nexus-email'],
+  },
+  {
+    id: 'blog-crud',
+    label: 'Blog CRUD',
+    description: 'Posts + authors + comments. nexus-data ODM deep dive.',
+    packagesDemoed: ['nexus-core', 'nexus-data', 'nexus-graphql'],
+  },
+  {
+    id: 'dashboard',
+    label: 'Dashboard',
+    description: 'Custom admin tabs + telemetry dashboards.',
+    packagesDemoed: ['nexus-core', 'nexus-telemetry'],
+  },
+  {
+    id: 'file-storage',
+    label: 'File storage',
+    description: 'Uploads, signed private URLs, image transform, S3.',
+    packagesDemoed: ['nexus-core'],
+  },
+  {
+    id: 'multi-app',
+    label: 'Multi-app',
+    description: 'Two backends, two frontends, single admin — Nexus as a platform.',
+    packagesDemoed: ['nexus-core'],
+  },
+];
+
+/** Look up by id. */
+export function getExample(id: string): ExampleMeta | null {
+  return EXAMPLES.find((e) => e.id === id) ?? null;
+}
+
+/** All ids (excluding empty). */
+export function exampleIds(): string[] {
+  return EXAMPLES.filter((e) => e.id !== 'empty').map((e) => e.id);
+}