aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMelody Horn <melody@boringcactus.com>2021-03-15 06:17:25 -0600
committerMelody Horn <melody@boringcactus.com>2021-03-15 06:17:25 -0600
commita106c948c2056cb855ae6603842c5c165f03d716 (patch)
treea3b94b924ebf3d487ce3a14b7c1f1b3eae7b0610
downloadhope-elixir.tar.gz
hope-elixir.zip
initialize Elixir projectelixir
-rw-r--r--.formatter.exs4
-rw-r--r--.gitignore27
-rw-r--r--README.md21
-rw-r--r--lib/hope.ex18
-rw-r--r--mix.exs28
-rw-r--r--test/hope_test.exs8
-rw-r--r--test/test_helper.exs1
7 files changed, 107 insertions, 0 deletions
diff --git a/.formatter.exs b/.formatter.exs
new file mode 100644
index 0000000..d2cda26
--- /dev/null
+++ b/.formatter.exs
@@ -0,0 +1,4 @@
+# Used by "mix format"
+[
+ inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
+]
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..53cbd1a
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,27 @@
+# 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 third-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").
+hope-*.tar
+
+
+# Temporary files for e.g. tests
+/tmp
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6750126
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Hope
+
+**TODO: Add description**
+
+## Installation
+
+If [available in Hex](https://hex.pm/docs/publish), the package can be installed
+by adding `hope` to your list of dependencies in `mix.exs`:
+
+```elixir
+def deps do
+ [
+ {:hope, "~> 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/hope](https://hexdocs.pm/hope).
+
diff --git a/lib/hope.ex b/lib/hope.ex
new file mode 100644
index 0000000..7f4e66f
--- /dev/null
+++ b/lib/hope.ex
@@ -0,0 +1,18 @@
+defmodule Hope do
+ @moduledoc """
+ Documentation for `Hope`.
+ """
+
+ @doc """
+ Hello world.
+
+ ## Examples
+
+ iex> Hope.hello()
+ :world
+
+ """
+ def hello do
+ :world
+ end
+end
diff --git a/mix.exs b/mix.exs
new file mode 100644
index 0000000..08cd57e
--- /dev/null
+++ b/mix.exs
@@ -0,0 +1,28 @@
+defmodule Hope.MixProject do
+ use Mix.Project
+
+ def project do
+ [
+ app: :hope,
+ version: "0.1.0",
+ elixir: "~> 1.11",
+ start_permanent: Mix.env() == :prod,
+ deps: deps()
+ ]
+ end
+
+ # Run "mix help compile.app" to learn about applications.
+ def application do
+ [
+ extra_applications: [:logger]
+ ]
+ 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/hope_test.exs b/test/hope_test.exs
new file mode 100644
index 0000000..ac9a8d4
--- /dev/null
+++ b/test/hope_test.exs
@@ -0,0 +1,8 @@
+defmodule HopeTest do
+ use ExUnit.Case
+ doctest Hope
+
+ test "greets the world" do
+ assert Hope.hello() == :world
+ end
+end
diff --git a/test/test_helper.exs b/test/test_helper.exs
new file mode 100644
index 0000000..869559e
--- /dev/null
+++ b/test/test_helper.exs
@@ -0,0 +1 @@
+ExUnit.start()