examples.json

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "schemaVersion": "workspai.examples-index.v1",
    "version": "1.2.0",
    "lastUpdated": "2026-08-08T00:00:00Z",
    "repository": "https://github.com/chistiq/rapidkit-examples",
    "validationBaseline": {
        "workspai": "0.55.1",
        "rapidkitCore": "0.6.0",
        "canonicalIntelligenceCommand": "workspai workspace intelligence run --for-agent generic --strict --json"
    },
    "publicationPolicy": {
        "repositoryRole": "public_cloneable_examples_and_showcases",
        "freeWorkspacesMustBeCloneable": true,
        "proSourcePolicy": "private_source_public_showcase",
        "catalogPromotionRequiresManifest": true
    },
    "proShowcases": [
        {
            "slug": "saas-starter-pro-workspace",
            "publicSlug": "saas-starter-pro",
            "workspaceSlug": "saas-starter-pro-workspace",
            "title": "SaaS Starter Pro",
            "path": "pro-showcase/saas-starter-pro-workspace",
            "sourcePolicy": "showcase_only",
            "privateProductIndex": "../rapidkit-examples-pro/products.json",
            "freeScaffoldPath": "saas-starter-workspace",
            "status": "public_showcase"
        },
        {
            "slug": "ai-support-agent-pro-workspace",
            "publicSlug": "ai-support-agent-pro",
            "workspaceSlug": "ai-support-agent-pro-workspace",
            "title": "AI Support Agent Pro",
            "path": "pro-showcase/ai-support-agent-pro-workspace",
            "sourcePolicy": "showcase_only",
            "privateProductIndex": "../rapidkit-examples-pro/products.json",
            "freeScaffoldPath": "my-ai-workspace",
            "status": "public_showcase"
        }
    ],
    "workspaces": [
        {
            "id": "my-ai-workspace",
            "name": "my-ai-workspace",
            "publicSlug": "ai-agent-workspace",
            "tier": "free",
            "lifecycleStatus": "published",
            "title": "AI Agent Workspace",
            "description": "Multi-provider AI assistant with FastAPI and NestJS implementations featuring streaming, caching, health checks, and support ticket endpoints.",
            "path": "my-ai-workspace",
            "tags": [
                "AI",
                "Streaming",
                "Multi-Provider",
                "OpenAI",
                "Production"
            ],
            "featured": true,
            "difficulty": "intermediate",
            "lastModified": "2026-07-12T00:00:00Z",
            "tutorialLinks": [
                {
                    "title": "Build Your First AI Agent with RapidKit",
                    "url": "https://rapidkit.medium.com/build-your-first-ai-agent-with-rapidkit-in-10-minutes-f38a6a12088d",
                    "platform": "Medium"
                },
                {
                    "title": "Build Your First AI Agent with RapidKit",
                    "url": "https://dev.to/rapidkit/build-your-first-ai-agent-with-rapidkit-in-10-minutes-3dj6",
                    "platform": "Dev.to"
                }
            ],
            "projects": [
                {
                    "id": "ai-agent",
                    "name": "ai-agent",
                    "type": "fastapi",
                    "displayName": "AI Agent (FastAPI)",
                    "description": "Production-ready FastAPI AI assistant with multi-provider support (echo/template/OpenAI-ready)",
                    "path": "my-ai-workspace/ai-agent",
                    "features": [
                        "Multi-provider AI completions",
                        "Streaming responses",
                        "Response caching",
                        "Health checks",
                        "OpenAI integration"
                    ],
                    "endpoints": [
                        "GET /docs",
                        "GET /ai/assistant/providers",
                        "POST /ai/assistant/completions",
                        "POST /ai/assistant/stream",
                        "GET /ai/assistant/health",
                        "POST /support/ticket"
                    ],
                    "defaultPort": 8000
                },
                {
                    "id": "ai-agent-nest",
                    "name": "ai-agent-nest",
                    "type": "nestjs",
                    "displayName": "AI Agent (NestJS)",
                    "description": "NestJS parity implementation with ai_assistant module + support/ticket workflow endpoint",
                    "path": "my-ai-workspace/ai-agent-nest",
                    "features": [
                        "ai_assistant module integration",
                        "Support ticket workflow",
                        "OpenAI provider registration",
                        "Swagger documentation",
                        "Health endpoints"
                    ],
                    "endpoints": [
                        "GET /docs",
                        "GET /health",
                        "GET /ai/assistant/providers",
                        "POST /ai/assistant/completions",
                        "POST /ai/assistant/stream",
                        "GET /ai/assistant/health",
                        "DELETE /ai/assistant/cache",
                        "POST /support/ticket"
                    ],
                    "defaultPort": 8013
                }
            ],
            "requirements": {
                "python": ">=3.10",
                "node": ">=20",
                "workspai": ">=0.55.1"
            },
            "quickStart": {
                "fastapi": [
                    "cd my-ai-workspace/ai-agent",
                    "npx workspai init",
                    "npx workspai dev"
                ],
                "nestjs": [
                    "cd my-ai-workspace/ai-agent-nest",
                    "npx workspai init",
                    "npx workspai dev -p 8013"
                ]
            }
        },
        {
            "id": "quickstart-workspace",
            "name": "quickstart-workspace",
            "publicSlug": "quickstart-workspace",
            "tier": "free",
            "lifecycleStatus": "published",
            "title": "Quickstart Workspace",
            "description": "Production-ready FastAPI demonstrating 5-minute setup with auth, database, caching, and monitoring.",
            "path": "quickstart-workspace",
            "tags": [
                "Quickstart",
                "Production-Ready",
                "Authentication",
                "PostgreSQL",
                "Redis",
                "Monitoring"
            ],
            "featured": true,
            "difficulty": "beginner",
            "lastModified": "2026-07-12T00:00:00Z",
            "tutorialLinks": [
                {
                    "title": "From Zero to Production API in 5 Minutes",
                    "url": "https://rapidkit.medium.com/from-zero-to-production-api-in-5-minutes",
                    "platform": "Medium"
                },
                {
                    "title": "From Zero to Production API in 5 Minutes",
                    "url": "https://dev.to/rapidkit/from-zero-to-production-api-in-5-minutes",
                    "platform": "Dev.to"
                }
            ],
            "projects": [
                {
                    "id": "product-api",
                    "name": "product-api",
                    "type": "fastapi",
                    "displayName": "Product API",
                    "description": "Complete production-ready API with JWT auth, PostgreSQL, Redis, CORS, security headers, logging, and health checks",
                    "path": "quickstart-workspace/product-api",
                    "features": [
                        "JWT Authentication (register, login, refresh)",
                        "PostgreSQL with SQLAlchemy (async & sync)",
                        "Redis caching with connection pooling",
                        "CORS & Security Headers",
                        "Structured JSON logging",
                        "Health checks & Prometheus metrics",
                        "Docker & docker-compose",
                        "CI/CD templates"
                    ],
                    "endpoints": [
                        "GET /docs",
                        "GET /health",
                        "GET /api/health/module/auth-core",
                        "GET /api/health/module/postgres",
                        "GET /api/health/module/redis",
                        "GET /metrics",
                        "POST /auth/register",
                        "POST /auth/login",
                        "GET /auth/me"
                    ],
                    "defaultPort": 8000
                },
                {
                    "id": "ecommerce-api",
                    "name": "ecommerce-api",
                    "type": "fastapi",
                    "displayName": "E-Commerce API",
                    "description": "Production-style ecommerce API with catalog, cart, checkout, auth-ready modules, PostgreSQL, Redis, and security defaults.",
                    "path": "quickstart-workspace/ecommerce-api",
                    "features": [
                        "Catalog management endpoints",
                        "Cart and checkout flow",
                        "PostgreSQL module wiring",
                        "Redis module wiring",
                        "Auth Core + Security Headers",
                        "Structured logging and module health"
                    ],
                    "endpoints": [
                        "GET /docs",
                        "GET /health",
                        "GET /api/v1/ecommerce/products",
                        "POST /api/v1/ecommerce/products",
                        "POST /api/v1/ecommerce/cart/items",
                        "POST /api/v1/ecommerce/checkout",
                        "GET /api/v1/ecommerce/orders/{order_id}",
                        "GET /api/health/module/postgres",
                        "GET /api/health/module/redis"
                    ],
                    "defaultPort": 8001
                }
            ],
            "requirements": {
                "python": ">=3.10",
                "workspai": ">=0.55.1",
                "docker": "recommended"
            },
            "quickStart": {
                "fastapi": [
                    "cd quickstart-workspace/product-api",
                    "docker-compose up -d postgres redis",
                    "npx workspai init",
                    "npx workspai dev"
                ]
            }
        },
        {
            "id": "saas-starter-workspace",
            "name": "saas-starter-workspace",
            "publicSlug": "saas-starter-workspace",
            "tier": "free",
            "lifecycleStatus": "published",
            "title": "SaaS Starter Workspace",
            "description": "Multi-project SaaS foundation with FastAPI and NestJS services covering auth, billing, admin operations, and webhook processing.",
            "path": "saas-starter-workspace",
            "tags": [
                "SaaS",
                "FastAPI",
                "NestJS",
                "Stripe",
                "Webhooks",
                "Multi-Project"
            ],
            "featured": true,
            "difficulty": "advanced",
            "lastModified": "2026-07-12T00:00:00Z",
            "tutorialLinks": [],
            "projects": [
                {
                    "id": "saas-api",
                    "name": "saas-api",
                    "type": "fastapi",
                    "displayName": "SaaS API (FastAPI)",
                    "description": "Main SaaS backend with auth, profile, subscription, billing, and team endpoints.",
                    "path": "saas-starter-workspace/saas-api",
                    "features": [
                        "JWT + Session auth",
                        "OAuth providers",
                        "Profile management",
                        "Subscriptions and billing",
                        "Teams/workspaces",
                        "Rate limiting"
                    ],
                    "endpoints": [
                        "POST /auth/register",
                        "POST /auth/login",
                        "GET /auth/oauth/{provider}",
                        "GET /users/profile",
                        "GET /subscriptions/plans",
                        "POST /subscriptions/checkout",
                        "GET /teams"
                    ],
                    "defaultPort": 8000
                },
                {
                    "id": "saas-admin",
                    "name": "saas-admin",
                    "type": "fastapi",
                    "displayName": "SaaS Admin (FastAPI)",
                    "description": "Admin backend for user moderation, subscription overview, and platform metrics.",
                    "path": "saas-starter-workspace/saas-admin",
                    "features": [
                        "Admin auth",
                        "User management",
                        "Subscription overview",
                        "Metrics and health"
                    ],
                    "endpoints": [
                        "POST /admin/auth/login",
                        "GET /admin/users",
                        "PUT /admin/users/{user_id}/ban",
                        "GET /admin/subscriptions",
                        "GET /admin/health"
                    ],
                    "defaultPort": 8001
                },
                {
                    "id": "saas-nest",
                    "name": "saas-nest",
                    "type": "nestjs",
                    "displayName": "SaaS API (NestJS)",
                    "description": "NestJS parity service demonstrating shared auth/profile workflows and standardized module health endpoints.",
                    "path": "saas-starter-workspace/saas-nest",
                    "features": [
                        "NestJS framework comparison",
                        "Auth/profile parity",
                        "Swagger docs",
                        "Shared /api/health/module/* routes"
                    ],
                    "endpoints": [
                        "POST /auth/register",
                        "POST /auth/login",
                        "GET /auth/me",
                        "GET /users/profile",
                        "GET /api/health/module/{module}"
                    ],
                    "defaultPort": 8002
                },
                {
                    "id": "saas-webhooks",
                    "name": "saas-webhooks",
                    "type": "fastapi",
                    "displayName": "SaaS Webhooks (FastAPI)",
                    "description": "Webhook ingestion service for Stripe events with signature verification, replay, and retry-oriented processing.",
                    "path": "saas-starter-workspace/saas-webhooks",
                    "features": [
                        "Stripe webhook intake",
                        "Signature verification",
                        "Webhook logs",
                        "Replay endpoint",
                        "Background processing",
                        "Email notification hooks"
                    ],
                    "endpoints": [
                        "POST /api/webhooks/stripe",
                        "GET /api/webhooks/logs",
                        "POST /api/webhooks/replay/{event_id}"
                    ],
                    "defaultPort": 8003
                }
            ],
            "requirements": {
                "python": ">=3.10",
                "node": ">=20",
                "workspai": ">=0.55.1",
                "docker": "recommended"
            },
            "quickStart": {
                "workspace": [
                    "cd saas-starter-workspace",
                    "npx workspai doctor workspace"
                ],
                "saas-api": [
                    "cd saas-starter-workspace/saas-api",
                    "npx workspai init",
                    "npx workspai dev"
                ],
                "saas-admin": [
                    "cd saas-starter-workspace/saas-admin",
                    "npx workspai init",
                    "npx workspai dev -p 8001"
                ],
                "saas-nest": [
                    "cd saas-starter-workspace/saas-nest",
                    "npx workspai init",
                    "npx workspai dev -p 8002"
                ],
                "saas-webhooks": [
                    "cd saas-starter-workspace/saas-webhooks",
                    "npx workspai init",
                    "npx workspai dev -p 8003"
                ]
            }
        }
    ],
    "profileWorkspaces": [
        {
            "id": "minimal",
            "name": "minimal-workspace",
            "profile": "minimal",
            "path": "minimal-workspace",
            "kind": "raw-profile-fixture",
            "projects": [],
            "pythonEngine": "not-required",
            "lifecycleStatus": "published"
        },
        {
            "id": "java-only",
            "name": "java-only-workspace",
            "profile": "java-only",
            "path": "java-only-workspace",
            "kind": "raw-profile-fixture",
            "projects": [],
            "pythonEngine": "not-required",
            "lifecycleStatus": "published"
        },
        {
            "id": "python-only",
            "name": "python-only-workspace",
            "profile": "python-only",
            "path": "python-only-workspace",
            "kind": "raw-profile-fixture",
            "projects": [],
            "pythonEngine": "skipped",
            "lifecycleStatus": "published"
        },
        {
            "id": "node-only",
            "name": "node-only-workspace",
            "profile": "node-only",
            "path": "node-only-workspace",
            "kind": "raw-profile-fixture",
            "projects": [],
            "pythonEngine": "not-required",
            "lifecycleStatus": "published"
        },
        {
            "id": "go-only",
            "name": "go-only-workspace",
            "profile": "go-only",
            "path": "go-only-workspace",
            "kind": "raw-profile-fixture",
            "projects": [],
            "pythonEngine": "not-required",
            "lifecycleStatus": "published"
        },
        {
            "id": "dotnet-only",
            "name": "dotnet-only-workspace",
            "profile": "dotnet-only",
            "path": "dotnet-only-workspace",
            "kind": "raw-profile-fixture",
            "projects": [],
            "pythonEngine": "not-required",
            "lifecycleStatus": "published"
        },
        {
            "id": "polyglot",
            "name": "polyglot-workspace",
            "profile": "polyglot",
            "path": "polyglot-workspace",
            "kind": "raw-profile-fixture",
            "projects": [],
            "pythonEngine": "skipped",
            "lifecycleStatus": "published"
        },
        {
            "id": "enterprise",
            "name": "enterprise-workspace",
            "profile": "enterprise",
            "path": "enterprise-workspace",
            "kind": "raw-profile-fixture",
            "projects": [],
            "pythonEngine": "skipped",
            "lifecycleStatus": "published"
        }
    ]
}