mix new --sup

twitchplaysvim · Feb 24, 2018 · c1e1db2 · c1e1db2
commit c1e1db2
Show file tree

Hide file tree

Showing 9 changed files with 155 additions and 0 deletions.
diff --git a/.formatter.exs b/.formatter.exs
@@ -0,0 +1,4 @@
+# Used by "mix format"
+[
+  inputs: ["mix.exs", "{config,lib,test}/**/*.{ex,exs}"]
+]
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,24 @@
+# The directory Mix will write compiled artifacts to.
+/_build/
+
+# If you run "mix test --cover", coverage assets end up here.
+/cover/
+
+# The directory Mix downloads your dependencies sources to.
+/deps/
+
+# Where 3rd-party dependencies like ExDoc output generated docs.
+/doc/
+
+# Ignore .fetch files in case you like to edit your project deps locally.
+/.fetch
+
+# If the VM crashes, it generates a dump, let's ignore it too.
+erl_crash.dump
+
+# Also ignore archive artifacts (built via "mix archive.build").
+*.ez
+
+# Ignore package tarball (built via "mix hex.build").
+relay-*.tar
+
diff --git a/README.md b/README.md
@@ -0,0 +1,21 @@
+# Relay
+
+**TODO: Add description**
+
+## Installation
+
+If [available in Hex](https://hex.pm/docs/publish), the package can be installed
+by adding `relay` to your list of dependencies in `mix.exs`:
+
+```elixir
+def deps do
+  [
+    {:relay, "~> 0.1.0"}
+  ]
+end
+```
+
+Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
+and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
+be found at [https://hexdocs.pm/relay](https://hexdocs.pm/relay).
+
diff --git a/config/config.exs b/config/config.exs
@@ -0,0 +1,30 @@
+# This file is responsible for configuring your application
+# and its dependencies with the aid of the Mix.Config module.
+use Mix.Config
+
+# This configuration is loaded before any dependency and is restricted
+# to this project. If another project depends on this project, this
+# file won't be loaded nor affect the parent project. For this reason,
+# if you want to provide default values for your application for
+# 3rd-party users, it should be done in your "mix.exs" file.
+
+# You can configure your application as:
+#
+#     config :relay, key: :value
+#
+# and access this configuration in your application as:
+#
+#     Application.get_env(:relay, :key)
+#
+# You can also configure a 3rd-party app:
+#
+#     config :logger, level: :info
+#
+
+# It is also possible to import configuration files, relative to this
+# directory. For example, you can emulate configuration per environment
+# by uncommenting the line below and defining dev.exs, test.exs and such.
+# Configuration from the imported file will override the ones defined
+# here (which is why it is important to import them last).
+#
+#     import_config "#{Mix.env}.exs"
diff --git a/lib/relay.ex b/lib/relay.ex
@@ -0,0 +1,18 @@
+defmodule Relay do
+  @moduledoc """
+  Documentation for Relay.
+  """
+
+  @doc """
+  Hello world.
+
+  ## Examples
+
+      iex> Relay.hello
+      :world
+
+  """
+  def hello do
+    :world
+  end
+end
diff --git a/lib/relay/application.ex b/lib/relay/application.ex
@@ -0,0 +1,20 @@
+defmodule Relay.Application do
+  # See https://hexdocs.pm/elixir/Application.html
+  # for more information on OTP Applications
+  @moduledoc false
+
+  use Application
+
+  def start(_type, _args) do
+    # List all child processes to be supervised
+    children = [
+      # Starts a worker by calling: Relay.Worker.start_link(arg)
+      # {Relay.Worker, arg},
+    ]
+
+    # See https://hexdocs.pm/elixir/Supervisor.html
+    # for other strategies and supported options
+    opts = [strategy: :one_for_one, name: Relay.Supervisor]
+    Supervisor.start_link(children, opts)
+  end
+end
diff --git a/mix.exs b/mix.exs
@@ -0,0 +1,29 @@
+defmodule Relay.MixProject do
+  use Mix.Project
+
+  def project do
+    [
+      app: :relay,
+      version: "0.1.0",
+      elixir: "~> 1.6",
+      start_permanent: Mix.env() == :prod,
+      deps: deps()
+    ]
+  end
+
+  # Run "mix help compile.app" to learn about applications.
+  def application do
+    [
+      extra_applications: [:logger],
+      mod: {Relay.Application, []}
+    ]
+  end
+
+  # Run "mix help deps" to learn about dependencies.
+  defp deps do
+    [
+      # {:dep_from_hexpm, "~> 0.3.0"},
+      # {:dep_from_git, git: "https://github.com/elixir-lang/my_dep.git", tag: "0.1.0"},
+    ]
+  end
+end
diff --git a/test/relay_test.exs b/test/relay_test.exs
@@ -0,0 +1,8 @@
+defmodule RelayTest do
+  use ExUnit.Case
+  doctest Relay
+
+  test "greets the world" do
+    assert Relay.hello() == :world
+  end
+end
diff --git a/test/test_helper.exs b/test/test_helper.exs
@@ -0,0 +1 @@
+ExUnit.start()