View Source mix beacon.install (Beacon v0.2.1)

Installs Beacon in a Phoenix LiveView app.

It will add the necessary dependencies and configuration into your Phoenix LiveView app.

The options --site and --path are optional but you can bootstrap a new site by providing them, otherwise execute mix beacon.gen.site at anytime to generate new sites.

You might want to install Beacon LiveAdmin as well to manage the content of your sites.

Examples

mix beacon.install
mix beacon.install --site my_site --path /

Options

  • --site or -s (optional) - The name of your site. Should not contain special characters nor start with "beacon_"
  • --path or -p (optional, defaults to "/") - Where your site will be mounted. Follows the same convention as Phoenix route prefixes.