Skip to content
Place your chips! Plan your sprints!
Elixir CSS HTML JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
assets
config
lib
priv
test
.buildpacks
.formatter.exs
.gitignore
Procfile
README.md
compile
elixir_buildpack.config
mix.exs
mix.lock

README.md

Chippy

To start your Phoenix server:

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

Now you can visit localhost:4000 from your browser.

Deployment

Chippy is deployed to Caktus' Dokku infrastructure. This document assumes that you are familiar with Caktus' Dokku Developer Docs and have an account on the Dokku server.

Create a new app:

   $ ssh dokku apps:create {{ project_name }}
   Creating {{ project_name }}... done

Create and link the database:

    $ ssh dokku postgres:create {{ project_name }}-database
    ...
    $ ssh dokku postgres:link {{ project_name }}-database {{ project_name }}
    ...

Set required environment variables:

    $ ssh dokku config:set {{ project_name }} HOSTNAME={{ project_name }}.caktustest.net
    $ ssh dokku config:set {{ project_name }} SECRET_KEY_BASE=<64char string>

Configure SSL via the Let's Encrypt Plugin:

    $ ssh dokku config:set --no-restart {{ project_name }} DOKKU_LETSENCRYPT_EMAIL=your@email.tld
    $ ssh dokku letsencrypt {{ project_name }}
    $ ssh dokku letsencrypt:cron-job --add {{ project_name }}

Configure the Git repository and deploy!

    $ git remote add dokku dokku:chippy
    $ git push dokku master

If you want to deploy a branch:

    $ git push dokku <branch-name>:master

Ready to run in production? Please check our deployment guides.

Local dev setup

The steps above should get you running. You can also make local configurations which won't go into version control. As an example, if you want the app to connect to Postgresql via unix domain sockets, add this to config/dev.secret.exs:

use Mix.Config

config :chippy, Chippy.Repo,
  socket_dir: "/var/run/postgresql",
  username: "vkurup",
  password: "",
  database: "chippy_dev",

To run the Phoenix server, while also having a command line to inspect stuff:

iex -S mix phx.server

Learn more

You can’t perform that action at this time.