Current section
Files
Jump to
Current section
Files
mix.exs
defmodule Zoonk.MixProject do
use Mix.Project
@scm_url "https://github.com/zoonk/zoonk"
def project do
[
app: :zoonk,
version: "0.3.0-alpha",
elixir: "~> 1.14",
elixirc_paths: elixirc_paths(Mix.env()),
start_permanent: Mix.env() == :prod,
aliases: aliases(),
deps: deps(),
dialyzer: [
plt_add_apps: [:mix],
plt_file: {:no_warn, "priv/plts/dialyzer.plt"},
ignore_warnings: ".dialyzer_ignore.exs"
],
name: "Zoonk",
source_url: @scm_url,
homepage_url: "https://zoonk.org",
docs: docs(),
package: package(),
description: "Open-source platform for creating interactive courses"
]
end
# Configuration for the OTP application.
#
# Type `mix help compile.app` for more information.
def application do
[
mod: {Zoonk.Application, []},
extra_applications: [:logger, :runtime_tools]
]
end
# Specifies which paths to compile per environment.
defp elixirc_paths(:test), do: ["lib", "test/support"]
defp elixirc_paths(_), do: ["lib"]
# Specifies your project dependencies.
#
# Type `mix help deps` for examples and options.
defp deps do
[
{:bcrypt_elixir, "~> 3.0"},
{:credo, "~> 1.7.0", only: [:dev, :test], runtime: false},
{:dialyxir, "~> 1.3.0", only: [:dev, :test], runtime: false},
{:ecto_sql, "~> 3.10.1"},
{:esbuild, "~> 0.7.0", runtime: Mix.env() == :dev},
{:ex_doc, "~> 0.29.4", only: :dev, runtime: false},
{:finch, "~> 0.14"},
{:floki, ">= 0.34.2", only: :test},
{:gettext, "~> 0.22.1"},
{:jason, "~> 1.4"},
{:mix_audit, "~> 2.1.0", only: [:dev, :test], runtime: false},
{:phoenix_ecto, "~> 4.4.1"},
{:phoenix_html, "~> 3.3.1"},
{:phoenix_live_dashboard, "~> 0.8.0"},
{:phoenix_live_reload, "~> 1.4.1", only: :dev},
{:phoenix_live_view, "~> 0.19.0"},
{:phoenix, "~> 1.7.3"},
{:plug_cowboy, "~> 2.6"},
{:postgrex, ">= 0.16.5"},
{:sobelow, "~> 0.12.1", only: [:dev, :test], runtime: false},
{:styler, "~> 0.7.12", only: [:dev, :test], runtime: false},
{:swoosh, "~> 1.11.0"},
{:tailwind, "~> 0.2.0", runtime: Mix.env() == :dev},
{:tailwind_formatter, "~> 0.3.5", only: [:dev, :test], runtime: false},
{:telemetry_metrics, "~> 0.6.1"},
{:telemetry_poller, "~> 1.0"}
]
end
# Aliases are shortcuts or tasks specific to the current project.
# For example, to install project dependencies and perform other setup tasks, run:
#
# $ mix setup
#
# See the documentation for `Mix` for more info on aliases.
defp aliases do
[
setup: ["deps.get", "ecto.setup", "assets.setup", "assets.build"],
"ecto.setup": ["ecto.create", "ecto.migrate", "run priv/repo/seeds.exs"],
"ecto.reset": ["ecto.drop", "ecto.setup"],
test: ["ecto.create --quiet", "ecto.migrate --quiet", "test"],
"assets.setup": ["tailwind.install --if-missing", "esbuild.install --if-missing"],
"assets.build": ["tailwind default", "esbuild default"],
"assets.deploy": ["tailwind default --minify", "esbuild default --minify", "phx.digest"],
ci: [
"compile --all-warnings --warnings-as-errors",
"format --check-formatted",
"credo --strict",
"sobelow -i Config.Headers --skip",
"deps.audit",
"dialyzer"
],
locale: ["gettext.extract", "gettext.merge priv/gettext"],
icons: ["icons"]
]
end
defp package do
[
maintainers: ["Will Ceolin"],
licenses: ["MIT"],
links: %{"GitHub" => @scm_url},
files:
~w(assets config lib priv/gettext priv/repo priv/static/favicon priv/static/images priv/static/robots.txt LICENSE README.md mix.exs .formatter.exs)
]
end
defp docs do
[
main: "overview",
logo: "priv/static/favicon/apple-touch-icon.png",
extra_section: "GUIDES",
formatters: ["html", "epub"],
extras: extras(),
groups_for_extras: groups_for_extras(),
nest_modules_by_prefix: nest_modules_by_prefix()
]
end
defp extras do
[
"guides/introduction/overview.md",
"guides/introduction/installation.md",
"guides/introduction/ssl.md",
"guides/introduction/permissions.md"
]
end
defp groups_for_extras do
[
Introduction: ~r/guides\/introduction\/.?/
]
end
defp nest_modules_by_prefix do
[
Zoonk.Accounts,
Zoonk.Content,
Zoonk.Fixtures,
Zoonk.Organizations,
ZoonkWeb.Components,
ZoonkWeb.Controller,
ZoonkWeb.Plugs,
ZoonkWeb.Shared
]
end
end