@spec boot(Beacon.Types.Site.t()) :: :ok

Boot a site executing the initial data population and resources loading.

It will populate default content data and routes in the router table, enable PubSub events broadcasting, and load resource modules for layouts, pages, and others.

This function is called by the site supervisor when a site is started and should not be called directly most of the times, but in some scenarions, you want to start Beacon and all related process like the Repo without actually booting the site, for example to seed initial data and in tests.

In those scenarios you'd define the config :mode to :manual in your site configuration, execute everything you need and then call Beacon.boot/1 to finally boot the site if necessary.

Note that calling this function will update the config :mode to :live after the site gets booted, so all PubSub events necessary for Beacon to work properly are broadcasted as expected.

Start Beacon and a supervisor for each site, which will load all layouts, pages, components, and so on.

You must include the Beacon supervisor on each application that you want it loaded. For a single Phoenix application that would go in the children list on the file lib/my_app/application.ex. For Umbrella apps you can have multiple apps running Beacon, suppose your project has 3 apps: core (regular app), blog (phoenix app), and marketing (phoenix app) and you want to load one Beacon instance on each Phoenix app, so you would include Beacon in the list of children applications in both blog and marketing applications with their own :sites configuration.

Note that each Beacon instance may have multiple sites and each site loads in its own supervisor. That gives you the flexibility to plan your architecture from simple to complex environments. For example, you can have a single site serving all pages in a single Phoenix application or you can create a new site to isolate a landing page for a marketing campaign that may receive too much traffic.

Options

Each site in :sites may have its own configuration, see all available options at Beacon.Config.new/1.

Examples

# config.exs or runtime.exs
config :my_app, Beacon,
  sites: [
    [site: :my_site, endpoint: MyAppWeb.Endpoint]
  ]

# lib/my_app/application.ex
def start(_type, _args) do
  children = [
    MyApp.Repo,
    {Phoenix.PubSub, name: MyApp.PubSub},
    {Beacon, Application.fetch_env!(:my_app, Beacon)}, # <- added Beacon here
    MyAppWeb.Endpoint
  ]

  opts = [strategy: :one_for_one, name: MyApp.Supervisor]
  Supervisor.start_link(children, opts)
end