From mix phx.new to a working app

PhoenixKit installs through Igniter. Its archive is a one-time setup, like phx_new:

$ mix archive.install hex igniter_new

In your Phoenix app:

$ mix igniter.install phoenix_kit

One command does the wiring:

• adds {:phoenix_kit, "~> 3.4"} and fetches it
• finds your Ecto repo and checks it is PostgreSQL
• generates the migrations
• adds config and a dev mailer
• adds the routes to your router
• offers to run the migrations

$ mix ecto.migrate && mix phx.server

Register at /phoenix_kit/users/register (the default URL prefix; set url_prefix to change it). The first account becomes the Owner, with full access to the admin at /phoenix_kit/admin.

localhost:4000/phoenix_kit/admin

Modules are separate packages. To add the CRM, put it in mix.exs:

{:phoenix_kit_crm, "~> 0.19"}

then fetch it and let PhoenixKit run its migrations:

$ mix deps.get && mix phoenix_kit.update

Switch it on under Admin → Modules and choose which roles may use it. The same three steps work for every module.

After bumping versions, mix phoenix_kit.update migrates core and every installed module together; mix phoenix_kit.status and mix phoenix_kit.doctor report what is out of date.