Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/blueberryapps/aloe

Aloe is a Rails engine that provides double entry bookkeeping functionality.
https://github.com/blueberryapps/aloe

Last synced: about 7 hours ago
JSON representation

Aloe is a Rails engine that provides double entry bookkeeping functionality.

Host: GitHub
URL: https://github.com/blueberryapps/aloe
Owner: blueberryapps
License: mit
Created: 2013-10-04T07:19:52.000Z (about 11 years ago)
Default Branch: master
Last Pushed: 2013-10-06T16:37:22.000Z (about 11 years ago)
Last Synced: 2024-09-18T00:32:40.735Z (about 2 months ago)
Language: Ruby
Size: 181 KB
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Aloe gem

[![Build Status](https://api.travis-ci.org/blueberryapps/aloe.png?branch=master)](http://travis-ci.org/blueberryapps/aloe)

Aloe is Ruby gem that provides double-entry bookkeeping infrastructure
for Rails. The name of gem is derived from fundamental accounting equation
A = L + OE.

## Instalation

Add aloe gem into your Gemfile:

gem 'aloe'

Generate the migration:

rails generate aloe

Then run the migrations:

rake db:migrate

## Example usage:

Each account must name, owner or both. Owner is an entity in your application,
for example following piece of code returns account belonging to the user:

user = User.first
account = Aloe::Ledger.find_account(user, :USD)

Moving money from one account to another is accomplished by creating an entry
in the ledger:

amount = Money.new(500, :USD)
Aloe::Ledger.create_entry money, from: debit_account, to: credit_accoun,

## TODO

* Multi-legged transactions support
* Currency converting transactions

## Dependencies

Aloe is Rails 4 engine. All models are based on ActiveRecord.

[Money](https://github.com/RubyMoney/money) is used for handling monetary
values.

## Issues

If you have problems, please create a
[Github Issue](https://github.com/blueberryapps/aloe/issues).

## License