mix ash_dispatch.install (AshDispatch v0.8.5)

View Source

Installs AshDispatch into a project

This installer will:

  • Add AshDispatch configuration to config files
  • Create Notification and DeliveryReceipt resources
  • Create Notifications and Deliveries domains
  • Add domains to your :ash_domains configuration
  • Create a RecipientResolver module for declarative audience resolution
  • Set up email layout templates
  • Optionally set up Phoenix channel for real-time updates

Example

mix igniter.install ash_dispatch

Options

  • --no-phoenix - Skip Phoenix channel setup
  • --no-email - Skip email backend configuration
  • --no-typescript - Generate plain resources and skip TypeScript SDK generation. Without the flag, the resources get AshTypescript.Resource when ash_typescript is a dependency, and the SDK is generated when a domain uses AshTypescript.Rpc.