Name		Name	Last commit message	Last commit date
parent directory ..
config		config
lib		lib
priv/repo/migrations		priv/repo/migrations
test		test
.env.example		.env.example
.formatter.exs		.formatter.exs
.gitignore		.gitignore
Dockerfile		Dockerfile
README.md		README.md
mix.exs		mix.exs
mix.lock		mix.lock

README.md

SPEK API

Running Tests

mix test

Coverage report: mix coveralls.html. Pretty information outputted into cover/excoveralls.html

Running as Development

Install dependencies with mix deps.get
Run cp .env.example .envrc if you're on Mac or Linux
Create a GitHub App, Gitlab OAuth application and paste credentials in .envrc
Compile and build spek mix do compile, release
Run spek _build/dev/rel/spek/bin/spek start

Autoformatting

mix format

Style ENFORCEMENT

mix credo --strict

ARCHITECTURE

Spek Api will roughly follow "functional core" architecture:

Contexts

Breeze - Web interface and contexts
Pulse - OTP-based transient state for Spek
Spek - OTP Application, Business Logic, and common toolsets
Telescope - Database, persistent state for Spek

Telescope.Access nonmutating queries
Telescope.Mutations mutating queries
Telescope.Queries composable Ecto.Query fragments
Telescope.Schemas database table schemas