https://github.com/slashdotdash/node-ledger-rest

REST web service to access the Ledger command-line interface (http://ledger-cli.org/).
https://github.com/slashdotdash/node-ledger-rest

Last synced: about 2 months ago
JSON representation

REST web service to access the Ledger command-line interface (http://ledger-cli.org/).

• Host: GitHub
• URL: https://github.com/slashdotdash/node-ledger-rest
• Owner: slashdotdash
• License: mit
• Created: 2013-03-24T10:32:49.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2018-03-11T20:27:45.000Z (over 6 years ago)
• Last Synced: 2024-04-22T02:15:26.702Z (5 months ago)
• Language: JavaScript
• Size: 18.6 KB
• Stars: 26
• Watchers: 4
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - slashdotdash/node-ledger-rest - REST web service to access the Ledger command-line interface (http://ledger-cli.org/). (others)

README

        
# ledger-rest

REST web service API to access the Ledger command-line interface ([ledger-cli.org](http://ledger-cli.org/)).

> Ledger is a powerful, double-entry accounting system that is accessed from the UNIX command-line.

MIT License

## Dependencies

  * [Ledger 3](http://ledger-cli.org/)

  * [Node.js](nodejs.org) and npm

### Installing Ledger

The simplest way to install Ledger 3 is through [Homebrew](http://mxcl.github.com/homebrew/).

```

brew install ledger --HEAD

```

The `--HEAD` option is required to install version 3.x.

## Usage

Install `ledger-rest` and its dependencies with npm.

```

npm install ledger-rest

```

Use the `LedgerRest` class to create a new RESTful server and start listening on a given port.

```js

var LedgerRest = require('ledger-rest').LedgerRest;

var server = new LedgerRest({ file: 'path/to/ledger/journal/file.dat' });

server.listen(3000);

```

Or use the command line runner to start a server listening on the given port and serving a single Ledger `.dat` file.

```

npm install ledger-rest -g

	

ledger-rest -p  -f path/to/ledger/journal/file.dat

```

To confirm the server is listening:

```

curl -H "Content-Type: application/json" http://localhost:/version

    

{"version":"3.1.1-20160111"}

```

The following endpoints are available:

* /version

* /balance

* /register