Skip to content

Commit

Permalink
Save Mix project scaffolding
Browse files Browse the repository at this point in the history
  • Loading branch information
erszcz committed Nov 30, 2023
1 parent 800b0df commit 906bd7c
Show file tree
Hide file tree
Showing 8 changed files with 127 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .formatter.exs
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Used by "mix format"
[
inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
]
26 changes: 26 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# 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").
uof_feed-*.tar

# Temporary files, for example, from tests.
/tmp/
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# UofFeed

**TODO: Add description**

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `uof_feed` to your list of dependencies in `mix.exs`:

```elixir
def deps do
[
{:uof_feed, "~> 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/uof_feed>.

18 changes: 18 additions & 0 deletions lib/uof_feed.ex
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
defmodule UofFeed do
@moduledoc """
Documentation for `UofFeed`.
"""

@doc """
Hello world.
## Examples
iex> UofFeed.hello()
:world
"""
def hello do
:world
end
end
20 changes: 20 additions & 0 deletions lib/uof_feed/application.ex
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
defmodule UofFeed.Application do
# See https://hexdocs.pm/elixir/Application.html
# for more information on OTP Applications
@moduledoc false

use Application

@impl true
def start(_type, _args) do
children = [
# Starts a worker by calling: UofFeed.Worker.start_link(arg)
# {UofFeed.Worker, arg}
]

# See https://hexdocs.pm/elixir/Supervisor.html
# for other strategies and supported options
opts = [strategy: :one_for_one, name: UofFeed.Supervisor]
Supervisor.start_link(children, opts)
end
end
29 changes: 29 additions & 0 deletions mix.exs
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
defmodule UofFeed.MixProject do
use Mix.Project

def project do
[
app: :uof_feed,
version: "0.1.0",
elixir: "~> 1.15",
start_permanent: Mix.env() == :prod,
deps: deps()
]
end

# Run "mix help compile.app" to learn about applications.
def application do
[
extra_applications: [:logger],
mod: {UofFeed.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
1 change: 1 addition & 0 deletions test/test_helper.exs
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ExUnit.start()
8 changes: 8 additions & 0 deletions test/uof_feed_test.exs
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
defmodule UofFeedTest do
use ExUnit.Case
doctest UofFeed

test "greets the world" do
assert UofFeed.hello() == :world
end
end

0 comments on commit 906bd7c

Please sign in to comment.