pk-modules

module
v0.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 19, 2026 License: Apache-2.0

README

pk-modules

Starter OSS module pack for PlatformKit.

This repo contains generic modules that demonstrate the public PlatformKit module contract. It should stay useful without becoming a product dump: community modules can follow these patterns, while vertical modules, client overlays, and hosted operational modules belong in Pro/private packs.

The repo also publishes .platformkit/docs.manifest.yaml so pk-docs can federate the module-pack overview through the same public documentation model used by downstream module packs.

Current Surface

  • pkg/coremodules: tenant, audit, and content example modules

Verify

make verify
make staticcheck

Directories

Path Synopsis
pkg
admin
Package admin implements the admin_management plugin module.
 Package admin implements the admin_management plugin module.
admin/static
Package adminstatic embeds the admin shell's static assets.
 Package adminstatic embeds the admin shell's static assets.
apikey
Package apikey implements the api_key_management business module.
 Package apikey implements the api_key_management business module.
apikey/migrations
Package migrations exposes the embedded api_key_management migration files as an io/fs.FS so application-level runners can replay them.
 Package migrations exposes the embedded api_key_management migration files as an io/fs.FS so application-level runners can replay them.
apikey/store
Package store defines the persistence contract for api_key_management.
 Package store defines the persistence contract for api_key_management.
apikey/store/sqlite
Package sqlite is the default Store implementation for api_key_management backed by database/sql.
 Package sqlite is the default Store implementation for api_key_management backed by database/sql.
audit
Package audit implements the audit_management business module.
 Package audit implements the audit_management business module.
audit/migrations
Package migrations exposes the embedded audit_management migration files as an io/fs.FS so application-level runners can replay them.
 Package migrations exposes the embedded audit_management migration files as an io/fs.FS so application-level runners can replay them.
audit/store
Package store defines the persistence contract for audit_management.
 Package store defines the persistence contract for audit_management.
audit/store/sqlite
Package sqlite is the default Store implementation for audit_management backed by database/sql.
 Package sqlite is the default Store implementation for audit_management backed by database/sql.
auth
Package auth implements the auth_management business module.
 Package auth implements the auth_management business module.
auth/migrations
Package migrations exposes the embedded auth_management migration files as an io/fs.FS so application-level runners can replay them.
 Package migrations exposes the embedded auth_management migration files as an io/fs.FS so application-level runners can replay them.
auth/store
Package store defines the persistence contract for auth_management.
 Package store defines the persistence contract for auth_management.
auth/store/sqlite
Package sqlite is the default SessionStore implementation for auth_management backed by database/sql.
 Package sqlite is the default SessionStore implementation for auth_management backed by database/sql.
content
Package content implements the content_management business module.
 Package content implements the content_management business module.
content/migrations
Package migrations exposes the embedded content_management migration files as an io/fs.FS so application-level runners can replay them.
 Package migrations exposes the embedded content_management migration files as an io/fs.FS so application-level runners can replay them.
content/store
Package store defines the persistence contract for content_management.
 Package store defines the persistence contract for content_management.
content/store/sqlite
Package sqlite is the default Store implementation for content_management backed by database/sql.
 Package sqlite is the default Store implementation for content_management backed by database/sql.
coremodules
Package coremodules provides the smallest OSS module pack.
 Package coremodules provides the smallest OSS module pack.
health
Package health implements the health_management business module.
 Package health implements the health_management business module.
homepage/overlay
Package overlay renders client-owned homepage overlay templates.
 Package overlay renders client-owned homepage overlay templates.
notification
Package notification implements the notification_management business module.
 Package notification implements the notification_management business module.
notification/migrations
Package migrations exposes the embedded notification_management migration files as an io/fs.FS so application-level runners can replay them.
 Package migrations exposes the embedded notification_management migration files as an io/fs.FS so application-level runners can replay them.
notification/store
Package store defines the persistence contract for notification_management.
 Package store defines the persistence contract for notification_management.
notification/store/sqlite
Package sqlite is the default Store implementation for notification_management backed by database/sql.
 Package sqlite is the default Store implementation for notification_management backed by database/sql.
portslib
Package portslib defines the shared port surfaces that pk-modules business modules use to expose admin pages, health checks, in-app notifications, translations, and configurable settings.
 Package portslib defines the shared port surfaces that pk-modules business modules use to expose admin pages, health checks, in-app notifications, translations, and configurable settings.
tenant
Package tenant implements the tenant_management business module.
 Package tenant implements the tenant_management business module.
tenant/migrations
Package migrations exposes the embedded tenant_management migration files as an io/fs.FS so application-level runners can replay them.
 Package migrations exposes the embedded tenant_management migration files as an io/fs.FS so application-level runners can replay them.
tenant/store
Package store defines the persistence contract for tenant_management.
 Package store defines the persistence contract for tenant_management.
tenant/store/sqlite
Package sqlite is the default Store implementation backed by database/sql.
 Package sqlite is the default Store implementation backed by database/sql.
user
Package user implements the user_management business module.
 Package user implements the user_management business module.
user/migrations
Package migrations exposes the embedded user_management migration files as an io/fs.FS so application-level runners can replay them.
 Package migrations exposes the embedded user_management migration files as an io/fs.FS so application-level runners can replay them.
user/store
Package store defines the persistence contract for user_management.
 Package store defines the persistence contract for user_management.
user/store/sqlite
Package sqlite is the default Store implementation for user_management backed by database/sql.
 Package sqlite is the default Store implementation for user_management backed by database/sql.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.