https://github.com/envato/double_entry-reporting

Reporting on Double Entry accounts and transfers
https://github.com/envato/double_entry-reporting

accounting finance gem ruby

Last synced: about 1 year ago
JSON representation

Reporting on Double Entry accounts and transfers

• Host: GitHub
• URL: https://github.com/envato/double_entry-reporting
• Owner: envato
• License: mit
• Created: 2018-10-13T02:35:05.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-02-18T05:28:56.000Z (over 2 years ago)
• Last Synced: 2025-05-11T09:07:04.538Z (about 1 year ago)
• Topics: accounting, finance, gem, ruby
• Language: Ruby
• Homepage:
• Size: 304 KB
• Stars: 6
• Watchers: 62
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# DoubleEntry Reporting

[![License MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/envato/double_entry-reporting/blob/master/LICENSE.md)

[![Gem Version](https://badge.fury.io/rb/double_entry-reporting.svg)](http://badge.fury.io/rb/double_entry-reporting)

[![Build Status](https://github.com/envato/double_entry-reporting/actions/workflows/ci.yml/badge.svg)](https://github.com/envato/double_entry-reporting/actions/workflows/ci.yml)

## Installation

In your application's `Gemfile`, add:

```ruby

gem 'double_entry-reporting'

```

Download and install the gem with Bundler:

```sh

bundle

```

Generate Rails schema migrations for the required tables:

```sh

rails generate double_entry:reporting:install

```

Update the local database:

```sh

rake db:migrate

```

## Development Environment Setup

1. Clone this repo.

    ```sh

    git clone git@github.com:envato/double_entry-reporting.git && cd double_entry-reporting

    ```

2. Run the included setup script to install the gem dependencies.

    ```sh

    ./script/setup.sh

    ```

3. Install MySQL, PostgreSQL and SQLite. We run tests against all three databases.

4. Create a database in MySQL.

    ```sh

    mysql -u root -e 'create database double_entry_reporting_test;'

    ```

5. Create a database in PostgreSQL.

    ```sh

    psql -c 'create database double_entry_reporting_test;' -U postgres

    ```

6. Specify how the tests should connect to the database

    ```sh

    cp spec/support/{database.example.yml,database.yml}

    vim spec/support/database.yml

    ```

7. Run the tests

    ```sh

    bundle exec rake

    ```