firefly-iii/README.md

56 lines
3.2 KiB
Markdown
Raw Normal View History

2014-07-02 06:23:03 -05:00
firefly-iii
===========
2014-07-09 07:05:17 -05:00
[![Build Status](https://travis-ci.org/JC5/firefly-iii.svg?branch=master)](https://travis-ci.org/JC5/firefly-iii)
[![Coverage Status](https://coveralls.io/repos/JC5/firefly-iii/badge.png?branch=master)](https://coveralls.io/r/JC5/firefly-iii?branch=master)
2014-07-15 04:02:11 -05:00
![Still maintained?](http://stillmaintained.com/JC5/firefly-iii.png)
2014-07-09 07:05:17 -05:00
2014-07-15 03:58:46 -05:00
[![Latest Stable Version](https://poser.pugx.org/grumpydictator/firefly-iii/v/stable.svg)](https://packagist.org/packages/grumpydictator/firefly-iii)
[![Total Downloads](https://poser.pugx.org/grumpydictator/firefly-iii/downloads.svg)](https://packagist.org/packages/grumpydictator/firefly-iii)
[![Latest Unstable Version](https://poser.pugx.org/grumpydictator/firefly-iii/v/unstable.svg)](https://packagist.org/packages/grumpydictator/firefly-iii)
[![License](https://poser.pugx.org/grumpydictator/firefly-iii/license.svg)](https://packagist.org/packages/grumpydictator/firefly-iii)
2014-07-09 07:05:17 -05:00
Firefly Mark III is a new version of Firefly built upon best practices and lessons learned
2014-07-09 07:10:54 -05:00
from building [Firefly](https://github.com/JC5/Firefly). It's Mark III since the original Firefly never made it outside of my
laptop and [Firefly II](https://github.com/JC5/Firefly) is live.
2014-07-02 06:23:03 -05:00
2014-07-02 06:30:23 -05:00
## Changes
2014-07-02 06:23:03 -05:00
Firefly III will feature:
- Double-entry bookkeeping system;
- Better budgeting tools;
- Better financial reporting;
- More control over other resources outside of personal finance
- Accounts shared with a partner (household accounts)
- Debts
- Credit cards
- More robust code base (mainly for my own peace of mind);
- More test-coverage (aka: actual test coverage);
2014-07-02 06:30:23 -05:00
## More features
2014-07-09 07:10:54 -05:00
2014-07-02 06:30:23 -05:00
- Firefly will be able to split transactions; a single purchase can be split in multiple entries, for more fine-grained control.
- Firefly will be able to join transactions.
- Transfers and transactions will be combined into one internal datatype which is more consistent with what you're actually doing: moving money from A to B. The fact that A or B or both are yours should not matter. And it will not, in the future.
- The nesting of budgets, categories and beneficiaries will be removed.
- Firefly will be able to automatically login a specified account. Although this is pretty unsafe, it removes the need for you to login to your own tool.
## Not changed
- Firefly will not encrypt the content of the (MySQL) tables. Old versions of Firefly had this capability but it sucks when searching, sorting and organizing entries.
2014-07-02 06:31:38 -05:00
## Current state
I have the basics up and running and test coverage is doing very well.
2014-07-09 07:10:54 -05:00
Current issues are the consistent look-and-feel of forms and likewise, the consistent inner workings of most of Firefly.
Example: every "create"-action tends to be slightly different from the rest. Also is the fact that not all lists
and forms are equally well thought of; some are not looking very well or miss feedback.
2014-07-09 07:10:54 -05:00
Most forms will not allow you to enter invalid data because the database cracks, not because it's actually checked.
2014-08-13 00:07:09 -05:00
I'm still thinking about a way to build consistent forms. Laravel doesn't really cut it.
2014-07-09 07:10:54 -05:00
2014-08-13 00:07:09 -05:00
A lot of views have CSRF vulnerabilities. The general advice is NOT to use this tool in production.
2014-07-09 07:10:54 -05:00
Questions, ideas or other things to contribute? [Let me know](https://github.com/JC5/firefly-iii/issues/new)!