Skip to content

👋 Hello Module

Module ID: @saas/hello-module | Version: 1.0.0 | Purpose: Smoke test / reference

Smoke-test registry item that proves the @saas registry install loop end-to-end. Use this as the minimal "does my registry work?" check and as a reference for authoring new modules.

Installation

bash
npx shadcn@latest add @saas/hello-module

Dependencies

No dependencies

Routes

No routes

Server Actions

No server actions

Database Tables

No database tables

Environment Variables

No environment variables

Files Installed

FileTarget Path
components/hello-banner.tsxRenders a simple "Hello from @saas registry" banner
lib/hello-utils.tsUtility helpers shipped with the module

Post-Install Steps

No post-install steps — files are ready to use immediately after install.

Verify the files landed:

bash
ls next-app/components/hello-banner.tsx
ls next-app/lib/hello-utils.ts

Use as a Template

The hello-module is the canonical minimal module reference. Copy its structure when authoring a new module:

registry/
  hello-module/
    module.manifest.json    # declares id, files, deps
    components/
      hello-banner.tsx      # component file
    lib/
      hello-utils.ts        # utility file

See the Authoring a Module guide for the full scaffolding workflow.

Uninstall (Manual Checklist)

  1. Delete next-app/components/hello-banner.tsx
  2. Delete next-app/lib/hello-utils.ts
  3. Remove any import references to these files from your app code

Released under the MIT License.