More documentation. Making sure all modules begin with Todo.

Author: bryanjos

README.md

@@ -1,19 +1,13 @@
 # Todo
 
+An example of using ElixirScript with a Phoenix 1.3 application.
+The ElixirScript code is in the `lib/todo_frontend` directory.
+The frontend uses the [ElixirScriptReact](https://github.com/elixirscript/elixirscript_react) library to create the view.
+
 To start your Phoenix app:
 
   * Install dependencies with `mix deps.get`
-  * Install Node.js dependencies with `npm install`
-  * Start Phoenix endpoint with `mix phoenix.server`
+  * Install Node.js dependencies with `(cd assets && npm install && cd ..)`
+  * Start Phoenix endpoint with `mix phx.server`
 
 Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
-
-Ready to run in production? Please [check our deployment guides](http://www.phoenixframework.org/docs/deployment).
-
-## Learn more
-
-  * Official website: http://www.phoenixframework.org/
-  * Guides: http://phoenixframework.org/docs/overview
-  * Docs: https://hexdocs.pm/phoenix
-  * Mailing list: http://groups.google.com/group/phoenix-talk
-  * Source: https://github.com/phoenixframework/phoenix

assets/js/app.js

@@ -21,4 +21,4 @@ import '../css/app.css';
 // import socket from "./socket"
 import Elixir from './build/Elixir.App';
 
-Elixir.start(Elixir.Main, []);
+Elixir.start(Elixir.Todo.Main, []);

lib/todo_frontend/data.ex

@@ -6,50 +6,50 @@ defmodule Todo.Data do
   """
 
   def list() do
-    Data.Http.fetch("/api/todo").then(fn(response) ->
+    Todo.Data.Http.fetch("/api/todo").then(fn(response) ->
       response.json()
     end).then(fn(todos) ->
         todos
       |> Enum.map(fn(x) -> %Todo.Todo{ id: x.id, completed: x.completed, title: x.title } end)
-      |> Main.update()
+      |> Todo.Main.update()
     end).catch(fn(err) ->
-      Data.Http.log(err)
+      Todo.Data.Http.log(err)
     end)
   end
 
   def add(the_title) do
-    Data.Http.fetch("/api/todo", ElixirScript.JS.map_to_object(%{
+    Todo.Data.Http.fetch("/api/todo", ElixirScript.JS.map_to_object(%{
       "method" => "post",
       "headers" => %{
         "Content-type" => "application/json"
       },
-      "body" => Data.Http.stringify(ElixirScript.JS.map_to_object(%{"title" => the_title}))
+      "body" => Todo.Data.Http.stringify(ElixirScript.JS.map_to_object(%{"title" => the_title}))
     })).then(fn(response) ->
       list()
     end).catch(fn(err) ->
-      Data.Http.log(err)
+      Todo.Data.Http.log(err)
     end)
   end
 
   def remove(id) do
-    Data.Http.fetch("/api/todo/" <> id, ElixirScript.JS.map_to_object(%{ "method" => "delete" })).then(fn(response) ->
+    Todo.Data.Http.fetch("/api/todo/" <> id, ElixirScript.JS.map_to_object(%{ "method" => "delete" })).then(fn(response) ->
       list()
     end).catch(fn(err) ->
-      Data.Http.log(err)
+      Todo.Data.Http.log(err)
     end)
   end
 
   def update(id, completed) do
-    Data.Http.fetch("/api/todo/" <> id, ElixirScript.JS.map_to_object(%{
+    Todo.Data.Http.fetch("/api/todo/" <> id, ElixirScript.JS.map_to_object(%{
       "method" => "put",
       "headers" => %{
         "Content-type" => "application/json"
       },
-      "body" => Data.Http.stringify(ElixirScript.JS.map_to_object(%{ "completed" => completed }))
+      "body" => Todo.Data.Http.stringify(ElixirScript.JS.map_to_object(%{ "completed" => completed }))
     })).then(fn(response) ->
       list()
     end).catch(fn(err) ->
-      Data.Http.log(err)
+      Todo.Data.Http.log(err)
     end)
   end
 end

lib/todo_frontend/data_http.ex

@@ -1,4 +1,4 @@
-defmodule Data.Http do
+defmodule Todo.Data.Http do
   @moduledoc """
   An FFI module for fetching data in JavaScript.
   """

lib/todo_frontend/document.ex

@@ -1,4 +1,4 @@
-defmodule Document do
+defmodule Todo.Document do
   @moduledoc """
   An FFI module for interacting with the document module
   in JavaScript.

lib/todo_frontend/main.ex

@@ -1,4 +1,4 @@
-defmodule Main do
+defmodule Todo.Main do
   use ReactUI
 
   @moduledoc """
@@ -98,7 +98,7 @@ defmodule Main do
       Todo.Data.add(event.target.value)
       ElixirScript.JS.mutate(event.target, "value", "")
     else
-      Data.Http.log(event)
+      Todo.Data.Http.log(event)
     end
   end
 end

mix.exs

@@ -11,7 +11,7 @@ defmodule Todo.Mixfile do
      start_permanent: Mix.env == :prod,
      deps: deps(),
      elixir_script: [
-       input: [Main],
+       input: [Todo.Main],
        output: "assets/js/build"
      ]
     ]