Skip to content

This is a phoenix demo app written for a presentation of phoenix at Stockholm Elixir.

Notifications You must be signed in to change notification settings

joakimk/phoenix_example_app

Repository files navigation

Circle CI

Phoenix example app

This is a phoenix demo app written for a presentation of phoenix at Stockholm Elixir.

It's intended to show how to setup a basic app including everything needed for dev, test, CI and production.

If you want to create a phoenix app, you can use this for inspiration, but first follow the instructions at the phoenix github page for setting up an app.

Note on testing

More tools will be needed to do request tests. I can recommend using httpotion. You also need to start a phoenix web server while running the tests. tuco_tuco looks like an interesting capybara-like tool for testing UIs (haven't tried it myself yet though).

Development

mix deps.get
mix phoenix.start

Though there isn't much to see right now.

Test

mix deps.get
mix test

CI

This app is prepared to run on circleci. If you'd like to do the same for your phoenix app, either copy "circle.yml" and "script/ci" or look at this gist.

CircleCi is free for open source code.

Setting up heroku deploy

This app is deployed at http://phoenix-example-app.herokuapp.com/. You can deploy your own app by adding a Procfile and a elixir_buildpack.config and then following these instructions.

heroku apps:create NAME-OF-YOUR-APP --buildpack https://github.com/HashNuke/heroku-buildpack-elixir.git
heroku config:set MIX_ENV=prod

# Only needed if you've changed config/prod.exs to use a SECRET_KEY_BASE env (recommended)
heroku config:set SECRET_KEY_BASE=$(elixir -e "IO.puts :crypto.strong_rand_bytes(64) |> Base.encode64")

git push heroku master

Credits and license

By Joakim Kolsjö under the MIT license:

Copyright © 2014 Joakim Kolsjö

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

This is a phoenix demo app written for a presentation of phoenix at Stockholm Elixir.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages