Hello World
v0.4.0A demo module to copy when building your own PhoenixKit module
Install Hello WorldA 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
{:phoenix_kit_hello_world, "~> 0.4"}
2 Fetch it and run its migrations
$ mix deps.get && mix phoenix_kit.update
3
Switch it on in /admin/modules
- Package
- phoenix_kit_hello_world
- Releases
-
- 0.4.0
- 0.3.0
- 0.2.2
- Admin
-
/admin/hello-world - Links
- HexDocs ↗ GitHub ↗ Changelog ↗
Related modules
What it needs, what builds on it, and its neighbours in Platform & tools.
Dashboards
Build admin dashboard pages from widgets that any module exposes
No other modules needed
Database Explorer
Browse Postgres tables and watch row changes live from the admin
No other modules needed
Legal
Generated legal pages, cookie consent banner and consent logging
Needs Publishing
Stats
Collect and chart time-series metrics from external sources over Graphite
No other modules needed
Sync
Pull data between PhoenixKit sites over token-based connections
No other modules needed
Templates Editor
Edit your app's email template files from the email settings page
Needs templates