https://github.com/xuhcc/beancount-mobile

Data entry app for Beancount plain-text accounting system
https://github.com/xuhcc/beancount-mobile

android beancount nativescript-application plaintext-accounting

Last synced: about 1 month ago
JSON representation

Data entry app for Beancount plain-text accounting system

• Host: GitHub
• URL: https://github.com/xuhcc/beancount-mobile
• Owner: xuhcc
• License: gpl-3.0
• Created: 2019-07-16T15:15:51.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-11-03T16:30:11.000Z (about 2 years ago)
• Last Synced: 2024-08-02T06:14:10.952Z (4 months ago)
• Topics: android, beancount, nativescript-application, plaintext-accounting
• Language: TypeScript
• Homepage:
• Size: 3.54 MB
• Stars: 112
• Watchers: 11
• Forks: 9
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-beancount - Beancount Mobile - Data entry app for Beancount plain-text accounting system (User Interfaces)

README

        
# Beancount Mobile App

[![GitHub release](https://img.shields.io/github/release/xuhcc/beancount-mobile)](https://github.com/xuhcc/beancount-mobile/releases)

[![License: GPL v3](https://img.shields.io/github/license/xuhcc/beancount-mobile)](https://github.com/xuhcc/beancount-mobile/blob/HEAD/LICENSE)

This is a companion mobile application for [Beancount](https://beancount.github.io/) plain-text accounting system.

**Currently available only on Android.** Version 6.0 (Marshmallow) or later is recommended.

## Features

* Add transactions

* Open accounts

* Declare currencies

* View beancount file as plain text

* Switch between files

 

Note: Beancount Mobile currently has no file synchronization functionality, but it's possible to use software like [Syncthing](https://syncthing.net/) to sync Beancount file across multiple devices.

## Configuration

Beancount Mobile makes use of these configuration options:

* `option "title" "..."` - the title of ledger file.

* `option "operating_currency" "..."` - default currency for transactions.

* `1970-01-01 custom "fava-option" "indent" "4"` - number spaces for indentation.

* `1970-01-01 custom "bcm_option" "transaction_flags" "['*', '!']"` - allowed transaction flags.

* `1970-01-01 custom "bcm_option" "account_order" "to_from"` - show "to" account before "from" account in transaction form.

## Change log

See [CHANGELOG](CHANGELOG.md).

## Development

Prerequisites:

* Node.js & NPM

* [NativeScript CLI](https://docs.nativescript.org/angular/start/quick-setup#step-2-install-the-nativescript-cli) 7.0

Install required packages:

```

npm install

```

### Android

Run on emulator:

```

npm run android

```

Build APK:

```

npm run android-debug

```

### Testing

```

npm run lint

npm run test

```