README.md

Phoenix Elm Scaffold

Mix Task to generate an elm app inside a Phoenix (1.3) app with the necessary scaffolding

Installation

Install the package by adding to deps and run mix deps.get

def deps do
  [{:phoenix_elm_scaffold, "~> 0.2.6"}]
end

Usage

To generate the scaffolding for an elm app, make sure you have elm installed and run:

> mix phx.gen.elm

this will generate the following files and run install commands:

├── assets
│   ├── elm
│   │   ├── Main.elm
│   │   ├── State.elm
│   │   ├── Types.elm
│   │   └── View.elm
│   ├── elm-package.json
│   ├── js
│   │   └── elm-embed.js
├── lib
│   └── your_app
│       └── web
│           ├── controllers
│           │   ├── elm_controller.ex
│           ├── templates
│           │   ├── elm
│           │   │   └── index.html.eex
│           └── views
│               └── elm_view.ex
└── test
    └── elm
        ├── Main.elm
        ├── Sample.elm
        └── elm-package.json

after the command has finished follow the next steps:

1: add the following to the plugins section of your brunch-config.js

elmBrunch: {
  elmFolder: ".", // Set to path where elm-package.json is located, defaults to project root
  mainModules: ['elm/Main.elm'],
  outputFile: 'elm.js',
  outputFolder: '../assets/js',
  makeParameters: ['--debug'] // optional debugger for development
}

2: add elm to the watched array in your brunch-config.js You may also want to add /elm\\.js/ to the babel ignore pattern to speed up compilation

babel: {
  ignore: [/vendor/, /elm\.js/]
}

3: in your app.js file add the following

import ElmApp from './elm.js'
import elmEmbed from './elm-embed.js'

elmEmbed.init(ElmApp)

4: and finally in your router.ex file add

get "/path-to-elm-app", ElmController, :index