firefly-iii/README.md

64 lines
3.5 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)
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-09-09 13:57:23 -05:00
## Current features
- [A double-entry bookkeeping system](http://en.wikipedia.org/wiki/Double-entry_bookkeeping_system).
- You can store, edit and remove withdrawals, deposits and transfers. This allows you full financial management;
- It's possible to create, change and manage money using _budgets_;
- Organize transactions using categories;
- Save towards a goal using piggy banks;
- Predict and anticipate large expenses using "repeated expenses" (ie. yearly taxes);
- Predict and anticipate bills using "recurring transactions" (rent for example).
Everything is organised:
- Clear views that should show you how you're doing;
- Easy navigation through your records;
- Browse back and forth to see previous months or even years;
- Lots of help text in case you don't get it;
- Lots of charts because we all love them.
2014-07-02 06:30:23 -05:00
## Changes
2014-07-02 06:23:03 -05:00
2014-09-09 13:57:23 -05:00
Firefly III will feature, but does not feature yet:
2014-07-02 06:23:03 -05:00
2014-09-09 13:57:23 -05:00
- Financial reporting showing you how well you are doing;
2014-07-02 06:23:03 -05:00
- More control over other resources outside of personal finance
- Accounts shared with a partner (household accounts)
- Debts
- Credit cards
- More test-coverage (aka: actual test coverage);
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.
2014-09-09 13:57:23 -05:00
- Transfers and transactions are 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.
- Any other features I might not have thought of.
2014-07-02 06:30:23 -05:00
2014-09-09 13:57:23 -05:00
Some stuff has been removed:
2014-07-02 06:30:23 -05:00
2014-09-09 13:57:23 -05:00
- The nesting of budgets, categories and beneficiaries is removed because it was pretty pointless.
2014-07-02 06:30:23 -05:00
- 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
2014-09-09 13:57:23 -05:00
I have the basics up and running. Test coverage is currently non-existent.
2014-07-09 07:10:54 -05:00
2014-09-09 13:57:23 -05:00
Although I have not checked extensively, some forms and views have CSRF vulnerabilities. This is because not all
views escape all characters by default. Will be fixed.
2014-07-09 07:10:54 -05:00
2014-09-09 13:57:23 -05:00
The current layout / look & feel is a pretty basic Bootstrap3 template. I am currently working on a more consistent,
expanded layout which will feature shiny AJAX things and data tables and all the Web 3.0 goodies you've come to expect
from social media sites.
2014-07-09 07:10:54 -05:00
2014-09-09 13:57:23 -05:00
Questions, ideas or other things to contribute? [Let me know](https://github.com/JC5/firefly-iii/issues/new)!