Skip to content

kimlindholm/phoenix_intercooler_tutorial

Repository files navigation

Phoenix + Intercooler Tutorial

CircleCI Coverage Status Ebert Docs

Tutorial and demo app

Description

TBD

Tutorial

TBD

Demo App

Requirements

  • Phoenix 1.3.0 or later
  • Elixir 1.5 or later
  • Erlang 20 or later
  • Heroku stack: heroku-16

Installation

To start your Phoenix server:

  • Install dependencies with mix deps.get
  • Create and migrate your database with mix ecto.create && mix ecto.migrate
  • Install Node.js dependencies with cd assets && npm install
  • Start Phoenix endpoint with mix s

Now you can visit localhost:4000 from your browser.

Deployment

TBD

Development

Some tools need to be installed globally:

$ mix archive.install hex sobelow
$ gem install scss-lint
$ brew install chromedriver         # MacOS
$ brew services start chromedriver  # MacOS

Testing

Before running tests, verify that ChromeDriver is running and that you're using Chrome 59 or later in order to run headless tests.

  • Run all tests: $ mix espec (same as $ mix es.all)
  • Run tests other than feature tests: $ mix es
  • Run feature tests: $ mix es.feat
  • Test coverage report: $ mix cov

Test coverage report is in file cover/excoveralls.html.

Code Analysis

$ mix sobelow --config
$ mix credo
$ scss-lint assets/css/
$ cd assets && yarn eslint

Documentation

Generate project documentation and check its quality:

$ mix docs
$ mix inch

License

TBD