EasyPage

This is a bundle of Phoenix components and scaffolding tools I use all the time. YMMV. One major motivation is that I do not like to have my entire liveview in one file, but rather split it into many small ones, which can involve tedious amounts of typing and boilerplate.

Installation

EasyPage can be installed by adding easy_page to your list of dependencies in mix.exs:

def deps do
  [
    {:easy_page, "~> 0.1.0"}
  ]
end

If you are only using the scaffolding features (probably recommended), then change it to:

def deps do
  [
    {:easy_page, "~> 0.1.0", only: :dev}
  ]
end

The docs can be found at https://hexdocs.pm/easy_page.

Usage

Add a bunch of template files somewhere (probably in assets). Then add something like this to your config/dev.exs

config :easy_page,
  scaffolds: [
    new: [
      replacements: ["index", "Index"],
      paths: [
        {"./assets/templates/new_page/index.exs", "./lib/demo_web/pages/index/index.ex"},
        {"./assets/templates/new_page/mount.exs", "./lib/demo_web/pages/index/mount.ex"},
        {"./assets/templates/new_page/handlers.exs", "./lib/demo_web/pages/index/handlers.ex"},
        {"./assets/templates/new_page/index_test.exs",
         "./test/demo_web/pages/index/index_test.exs"}
      ]
    ]
  ]

To get started quickly, grab the templates from https://github.com/greetingsfellowhumans/easy_page/tree/main/assets/templates and place them in ./assets/templates/

Now finally we get to use the handy CLI

mix easy_page

Which will walk you through the process of copying the files from their template path, into the destination path specified in the config. As it copies, it will automatically search and replace text.

You can create your own custom scaffolds beyond just :new.

Remember the default templates are just a starting point. You can, and SHOULD customize them to make them your own. As a base, they just create a simple page with a live_view tabination component. There are separate modules for the page entrypoint, the mount function, handlers, and a test.

You will want to go through each template file and replace DemoWeb with your own module name, as well as change the destination paths accordingly.