# MoneyBin
[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT) [![Build Status](https://travis-ci.com/KazW/money_bin.svg?token=CRsKZKYLbnQZUawkaRLB&branch=master)](https://travis-ci.com/KazW/money_bin) [![Ebert](https://ebertapp.io/github/KazW/money_bin.svg)](https://ebertapp.io/github/KazW/money_bin) [![Inline docs](http://inch-ci.org/github/KazW/money_bin.svg)](http://inch-ci.org/github/KazW/money_bin)

Flexible double entry based accounting for Ecto.

## Installation

Add MoneyBin to your deps:
```elixir
{:money_bin, "~> 0.0.1"}
```

Configure which repo MoneyBin should use:
```elixir
# MoneyBin configuration
config :money_bin, :settings, repo: MyApp.Repo
```

Generate a migration:
```shell
mix ecto.gen.migration create_money_bin
```

Add the following to the change method:
```elixir
defmodule MyApp.Repo.Migrations.CreateMoneyBin do
  use Ecto.Migration

  def change do
    MoneyBin.Migrations.change()
  end
end
```

## Documentation
[Online (hex) Docs](https://hexdocs.pm/money_bin)

## Configuration
These are the default configuration values, aside from repo, which must be provided. Setting table names through this interface configures both the schemas and migrations. Using schemas other than the default is not recommended.
```elixir
# MoneyBin configuration
config :money_bin, :settings,
  repo: MyApp.Repo,
  tables: [
    account: "accounts",
    transaction: "transactions",
    journal_entry: "journal_entries",
    ledger: "ledgers",
    ledger_member: "ledger_members"
  ],
  schemas: [
    account: MoneyBin.Account,
    transaction: MoneyBin.Transaction,
    journal_entry: MoneyBin.JournalEntry,
    ledger: MoneyBin.Ledger,
    ledger_member: MoneyBin.LedgerMember
  ]
```

## License

Copyright © 2018 Kaz Walker & Contributors

MIT License

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.