Skip to content

Commit

Permalink
create msg_board project
Browse files Browse the repository at this point in the history
  • Loading branch information
Steven Fuchs committed Jan 8, 2019
1 parent cc4916b commit f605925
Show file tree
Hide file tree
Showing 9 changed files with 155 additions and 0 deletions.
4 changes: 4 additions & 0 deletions msg_board/.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}"]
]
24 changes: 24 additions & 0 deletions msg_board/.gitignore
Original file line number Diff line number Diff line change
@@ -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").
msg_board-*.tar

21 changes: 21 additions & 0 deletions msg_board/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# MsgBoard

**TODO: Add description**

## Installation

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

```elixir
def deps do
[
{:msg_board, "~> 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/msg_board](https://hexdocs.pm/msg_board).

30 changes: 30 additions & 0 deletions msg_board/config/config.exs
Original file line number Diff line number Diff line change
@@ -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 :msg_board, key: :value
#
# and access this configuration in your application as:
#
# Application.get_env(:msg_board, :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"
18 changes: 18 additions & 0 deletions msg_board/lib/msg_board.ex
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
defmodule MsgBoard do
@moduledoc """
Documentation for MsgBoard.
"""

@doc """
Hello world.
## Examples
iex> MsgBoard.hello()
:world
"""
def hello do
:world
end
end
20 changes: 20 additions & 0 deletions msg_board/lib/msg_board/application.ex
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
defmodule MsgBoard.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: MsgBoard.Worker.start_link(arg)
# {MsgBoard.Worker, arg},
]

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

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

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

test "greets the world" do
assert MsgBoard.hello() == :world
end
end
1 change: 1 addition & 0 deletions msg_board/test/test_helper.exs
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ExUnit.start()

0 comments on commit f605925

Please sign in to comment.