Phoenix Base

Phoenix Base is the base Phoenix app template used at Flatstack. It's based on Elixir 1.5 and Phoenix 1.2.

Application libs

ErlExec execute and control OS processes from Erlang/OTP
Elixir release manager for Elixir's apps release management
ExtensibleEffects Monadic, softly-typed, extensible effect handling
Guardian an authentication framework
Guardsafe macros expanding into code that can be safely used in guard clauses
LoggerFileBackend for writing logs into file
Monadex improve pipelines with monads
OK macros for elegant error handling in elixir pipelines

Development libs

Credo for reporting violations of the Elixir style guide
Dialyzer for static analyse
Eper Erlang performance related tools
EDeliver provides a bash script to build and deploy Elixir and Erlang applications and perform hot-code upgrades
ExDoc tool to generate documentation for your Elixir projects
Observer-CLI visualize Erlang nodes on the command line

Testing libs

ExMachina makes it easy to create test data and associations
ESpec for unit testing
Faker pure Elixir library for generating fake data

Scripts

bin/setup - setup required libraries and stuff
bin/quality - runs code style check tools
bin/ci - should be used in the CI or locally
bin/build - to build application release
bin/server - to run server locally
bin/docs - to generate local docs
bin/deploy [production] - to deploy using EDeliver

Getting Started

Prepare dependencies

Elixir v1.5 and Postgres should be installed.

Bootstrap application

Clone application as new project with original repository named "phoenix-base".

git clone git://github.com/fs/phoenix-base.git --origin phoenix-base [MY-NEW-PROJECT]

Create your new repo on GitHub and push master into it. Make sure master branch is tracking origin repo.
```
git remote add origin git@github.com:[MY-GITHUB-ACCOUNT]/[MY-NEW-PROJECT].git
git push -u origin master
```
Run setup script
```
bin/setup
```
Run test and quality suits to make sure all dependencies are satisfied and applications works correctly before making changes.
```
bin/ci
```
Run app
```
bin/server
```
Update README

Do not forget to update application README.md file with detailed information based on the existing template.
```
mv doc/README_TEMPLATE.md README.md
# update README.md
git commit -am "Update README.md"
```

Deployment

Elixir Release Manager

Use ./bin/build script to build Elixir application release.

Heroku

You can use Elixir buildpack for Heroku to be deployed:

Heroku Postgres add-on will be used for database.
SendGrid add-on required to be able to send emails.
Rollbar add-on could be used to application errors.

heroku create --addons=heroku-postgresql,sendgrid,newrelic,rollbar --remote staging phoenix-base-example --buildpack "https://github.com/HashNuke/heroku-buildpack-elixir.git"
heroku config:add HOST="phoenix-base-example.herokuapp.com"
git push staging master
heroku open

EDeliver

You can use EDeliver to deploy Erlang releases on remote hosts. Provide .deliver/config configuration first:

  cp ~./.deliver/config.example ~/.deliver/config
  ./bin/deploy

Code style

All Elixir code should be written following Elixir Style Guide.

Architecture

Please follow the next project structure:

lib - application sources
web - web related sources
config - app configuration
spec - application tests

Debugging

Use IEx.pry with Erlang-history for interactive console
Observer to observe started Erlang processes
Use Erlang's dbg for debugging function calls
Use Erlang's Debugger with graphical interface

Testing

Hound tests require phantomjs started in WebDriver mode:

phantomjs --wd

Credits

Phoenix Base was written and maintained by by Flatstack with the help of our contributors.

fs / phoenix-base

readme