Installation

StarView can be installed with Igniter, or wired manually in a Phoenix project.

Quick Install

mix igniter.install star_view

The installer sets up the recommended Phoenix development flow:

• Adds the dependency.
• Adds StarView.StreamRegistry to your supervision tree.
• Adds a dedicated star_view section to your web module after controller.
• Generates YourAppWeb.Components.StarView.Layout for the StarView document layout and page wrapper.
• Configures HTTPS and https://<hyphenated-otp-app>.test:4001 as the dev URL.
• Provides mix star_view.trust to add the local host entry and generate a browser-trusted HTTPS certificate with mkcert.
• Adds the POST /ds/:module/:event route and RenameCsrfParam before CSRF protection.
• Adds the optional /search sample page route.
• Generates a sample search controller.
• Provides mix dev, which delegates to mix star_view.server.

Install mkcert first:

brew install mkcert nss

Then run the trust step directly after install:

mix star_view.trust

It adds the .test host to /etc/hosts, runs mkcert -install, and writes priv/cert/selfsigned.pem plus priv/cert/selfsigned_key.pem. It may prompt for sudo privileges. Run it before mix dev so Phoenix can find the configured certificate files.

Skip parts you do not want:

mix igniter.install star_view --no-stream-dedup --no-https --no-example

The routing/CSRF setup is also available independently:

mix star_view.setup.dispatch

This task registers POST, not every action verb. Add matching GET/DELETE/PUT/PATCH routes only when used, as shown in action routing. Handlers must enforce their allowed methods; GET remains read-only.

Manual Dependency

def deps do
  [
    {:star_view, "~> 0.7.0"}
  ]
end

Add StarView.StreamRegistry to your supervision tree if you want per-tab stream deduplication:

children = [
  StarView.StreamRegistry,
  # ...
]

The remaining manual Phoenix setup is covered in the Phoenix web module and layout guides.