Skip to content

Commit c75c280

Browse files
committed
Init
0 parents  commit c75c280

8 files changed

+154
-0
lines changed

.formatter.exs

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Used by "mix format"
2+
[
3+
inputs: ["mix.exs", "{config,lib,test}/**/*.{ex,exs}"]
4+
]

.gitignore

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# The directory Mix will write compiled artifacts to.
2+
/_build/
3+
4+
# If you run "mix test --cover", coverage assets end up here.
5+
/cover/
6+
7+
# The directory Mix downloads your dependencies sources to.
8+
/deps/
9+
10+
# Where 3rd-party dependencies like ExDoc output generated docs.
11+
/doc/
12+
13+
# Ignore .fetch files in case you like to edit your project deps locally.
14+
/.fetch
15+
16+
# If the VM crashes, it generates a dump, let's ignore it too.
17+
erl_crash.dump
18+
19+
# Also ignore archive artifacts (built via "mix archive.build").
20+
*.ez
21+
22+
# Ignore package tarball (built via "mix hex.build").
23+
hierarch-*.tar
24+

README.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Hierarch
2+
3+
**TODO: Add description**
4+
5+
## Installation
6+
7+
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
8+
by adding `hierarch` to your list of dependencies in `mix.exs`:
9+
10+
```elixir
11+
def deps do
12+
[
13+
{:hierarch, "~> 0.1.0"}
14+
]
15+
end
16+
```
17+
18+
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
19+
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
20+
be found at [https://hexdocs.pm/hierarch](https://hexdocs.pm/hierarch).
21+

config/config.exs

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# This file is responsible for configuring your application
2+
# and its dependencies with the aid of the Mix.Config module.
3+
use Mix.Config
4+
5+
# This configuration is loaded before any dependency and is restricted
6+
# to this project. If another project depends on this project, this
7+
# file won't be loaded nor affect the parent project. For this reason,
8+
# if you want to provide default values for your application for
9+
# 3rd-party users, it should be done in your "mix.exs" file.
10+
11+
# You can configure your application as:
12+
#
13+
# config :hierarch, key: :value
14+
#
15+
# and access this configuration in your application as:
16+
#
17+
# Application.get_env(:hierarch, :key)
18+
#
19+
# You can also configure a 3rd-party app:
20+
#
21+
# config :logger, level: :info
22+
#
23+
24+
# It is also possible to import configuration files, relative to this
25+
# directory. For example, you can emulate configuration per environment
26+
# by uncommenting the line below and defining dev.exs, test.exs and such.
27+
# Configuration from the imported file will override the ones defined
28+
# here (which is why it is important to import them last).
29+
#
30+
# import_config "#{Mix.env}.exs"

lib/hierarch.ex

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
defmodule Hierarch do
2+
@moduledoc """
3+
Documentation for Hierarch.
4+
"""
5+
6+
@doc """
7+
Hello world.
8+
9+
## Examples
10+
11+
iex> Hierarch.hello
12+
:world
13+
14+
"""
15+
def hello do
16+
:world
17+
end
18+
end

mix.exs

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
defmodule Hierarch.MixProject do
2+
use Mix.Project
3+
4+
@project_url "https://github.com/GreenNerd-Labs/hierarch"
5+
@version "0.1.0"
6+
7+
def project do
8+
[
9+
app: :hierarch,
10+
version: @version,
11+
elixir: "~> 1.6",
12+
start_permanent: Mix.env() == :prod,
13+
source_url: @project_url,
14+
homepage_url: @project_url,
15+
description: description(),
16+
package: package(),
17+
deps: deps()
18+
]
19+
end
20+
21+
# Run "mix help compile.app" to learn about applications.
22+
def application do
23+
[
24+
extra_applications: [:logger]
25+
]
26+
end
27+
28+
# Run "mix help deps" to learn about dependencies.
29+
defp deps do
30+
[
31+
# {:dep_from_hexpm, "~> 0.3.0"},
32+
# {:dep_from_git, git: "https://github.com/elixir-lang/my_dep.git", tag: "0.1.0"},
33+
]
34+
end
35+
36+
defp description() do
37+
"Hierarchy structure for ecto models with PostgreSQL LTree."
38+
end
39+
40+
defp package() do
41+
[
42+
name: :hierarch,
43+
files: ["lib", "mix.exs", "README*", "LICENSE*"],
44+
licenses: ["MIT"],
45+
links: %{"GitHub" => @project_url}
46+
]
47+
end
48+
end

test/hierarch_test.exs

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
defmodule HierarchTest do
2+
use ExUnit.Case
3+
doctest Hierarch
4+
5+
test "greets the world" do
6+
assert Hierarch.hello() == :world
7+
end
8+
end

test/test_helper.exs

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ExUnit.start()

0 commit comments

Comments
 (0)