Shifu

Introduction

Shifu: Elixir Boilerplate:

• Postgres
• Sentry
• Redis (Todo)
• Sockets (Todo)

Dependencies

  Elixir v1.13.2
  Phoenix 1.6.6
  Erlang/OTP 24

Installation

Envrionment Variables

export API_BASE_URL="http://localhost:8000"

# Module configs
export STORAGE_PATH="/tmp"

# Database / PostgresDB configs
export DATABASE_HOST="127.0.0.1"
export DATABASE_USERNAME="admin"
export DATABASE_PASSWORD="admin"
export DATABASE_PORT="5432"
export DATABASE_NAME="shifu"
export DATABASE_APPLICATION_NAME="shifu"
export DATABASE_POOL_MAX="1"

# Log level
export LOG_LEVEL="info"

# sentryDSN
export SENTRY_DSN="xxx"

Setup / Run

git clone https://github.com/surya4/shifu shifu
cd shifu
mix deps.get
mix start

Code Testing

mix deps.get
mix test

Check code coverage

mix coveralls

Code linting

mix credo

Check code formatting

mix format --check-formatted

Compilation errors

mix compile --warnings-as-errors --all-warnings

Static code analyzer

mix dialyzer

Fix code formatting

mix format