bill

This README is the one indexed from the repository at its latest ref, not from the tag for this version.

# Bill

**Bill** is an Accounts Receivable automation system for *Lucky* framework. It includes tools for creating and tracking invoices, credit notes, receipts and more.

*Bill* keeps an immutable ledger of transactions from which balances can be efficiently computed. Whenever a business event occurs, a record is kept in this ledger.

*Bill* is designed for use cases where a self-service application charges users for products or services, or for online marketplaces where businesses charge registered users for same.

## Documentation

Find the complete documentation in the `docs/` directory of this repository.

## Todo

- [x] Ledger
- [x] Invoices
- [ ] Taxes
- [ ] Discounts
- [x] Credit Notes
- [x] Receipts
- [ ] Businesses

## Development

Create a `.env` file:

```env
DATABASE_URL=postgres://postgres:password@localhost:5432/bill_spec
```

Update the file with your own details. Then run tests with `crystal spec`.

## Contributing

1. [Fork it](https://github.com/GrottoPress/bill/fork)
1. Switch to the `master` branch: `git checkout master`
1. Create your feature branch: `git checkout -b my-new-feature`
1. Make your changes, updating changelog and documentation as appropriate.
1. Commit your changes: `git commit`
1. Push to the branch: `git push origin my-new-feature`
1. Submit a new *Pull Request* against the `GrottoPress:master` branch.