# `mix cardbox.install`
[🔗](https://github.com/hattoriai/cardbox/blob/v0.1.0/lib/mix/tasks/cardbox.install.ex#L5)

Sets up Cardbox in a Phoenix application.

    $ mix igniter.install cardbox

or, with Cardbox already in the deps, `mix cardbox.install`.
[Igniter](https://hexdocs.pm/igniter) shows each change as a diff and
asks before it writes (`--dry-run` only shows them, `--yes` does not
ask). Running the task again changes nothing.

  * `lib/my_app/cardbox.ex` - your module of Cardbox's, with your repo
    and your PubSub, and the callbacks to write as comments: your file,
    written once;
  * the migration of Cardbox's tables (`mix cardbox.gen.migration`), in
    the migrations of your repo, unless one pins the latest version
    already.

Then run `mix ecto.migrate`, and draw a view: see the Quickstart.

## Options

  * `--repo` - the repo of the tables, when the app has several.

---

*Consult [api-reference.md](api-reference.md) for complete listing*