Skip to content

Hello World

v0.4.0

A demo module to copy when building your own PhoenixKit module

Install Hello World

A minimal demo module meant as a template for building your own PhoenixKit modules. It shows the full-featured pattern (admin tab, settings, routes, permissions) and its README is a long developer guide covering headless modules, callbacks, navigation, permissions, components, JavaScript, database conventions, testing and publishing to Hex.

Use it when

  • You are starting your own PhoenixKit module and want a working skeleton
  • You need examples of permissions, activity logging, widgets and translations in a module

What it gives you

  • Auto-discovered admin sidebar tab and enable/disable toggle
  • Permission key and a sub-permission checked with Scope.can?/2
  • Own Gettext backend (Estonian and Russian)
  • Activity logging, an activity feed and notifications
  • A dashboard widget and a project extension as integration examples

Hello World news

Nothing posted about Hello World yet. Read its changelog or see all PhoenixKit news.

Install

1 Add to mix.exs

deps
{:phoenix_kit_hello_world, "~> 0.4"}

2 Fetch it and run its migrations

Terminal
$ mix deps.get && mix phoenix_kit.update

3 Switch it on in /admin/modules

Releases
  1. 0.4.0
  2. 0.3.0
  3. 0.2.2
Admin
/admin/hello-world

Related modules

What it needs, what builds on it, and its neighbours in Platform & tools.