mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2024-12-29 02:11:12 -06:00
100 lines
5.2 KiB
Markdown
100 lines
5.2 KiB
Markdown
# Firefly III (v3.4.3)
|
|
|
|
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/JC5/firefly-iii/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/JC5/firefly-iii/?branch=master)
|
|
[![Code Coverage](https://scrutinizer-ci.com/g/JC5/firefly-iii/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/JC5/firefly-iii/?branch=master)
|
|
[![Build Status](https://scrutinizer-ci.com/g/JC5/firefly-iii/badges/build.png?b=master)](https://scrutinizer-ci.com/g/JC5/firefly-iii/build-status/master)
|
|
|
|
## About
|
|
|
|
"Firefly III" is a financial manager. It can help you keep track of expenses, income, budgets and everything in between. It even supports credit cards, shared
|
|
household accounts and savings accounts! It's pretty fancy. You should use it to save and organise money.
|
|
|
|
_Firefly is a system you'll have install yourself on webhosting of your choosing._
|
|
|
|
Personal financial management is pretty difficult, and everybody has their own approach to it. Some people
|
|
make budgets, other people limit their cashflow by throwing away their credit cards, others try to increase
|
|
their current cashflow. There are tons of ways to save and earn money.
|
|
|
|
Firefly works on the principle that if you know where you're money is going, you can stop it from going there.
|
|
|
|
|
|
To get to know Firefly, and to see if it fits you, check out these resources:
|
|
|
|
- The screenshots below on this very page.
|
|
- The featurelist below, also on this very page.
|
|
- The [full description](https://github.com/JC5/firefly-iii/wiki/full-description), which will tell you how Firefly works,
|
|
and the philosophy behind it.
|
|
|
|
|
|
#### About the name (if you care)
|
|
|
|
It's III, or 3, because [version 2](https://github.com/JC5/Firefly) and version 1 (not online) preceded it. It has been growing steadily ever since.
|
|
|
|
## Current features
|
|
|
|
- [A double-entry bookkeeping system](https://en.wikipedia.org/wiki/Double-entry_bookkeeping_system);
|
|
- You can store, edit and remove [withdrawals, deposits and transfers](https://en.wikipedia.org/wiki/Financial_transaction). This allows you full financial management;
|
|
- You can manage different types of accounts;
|
|
- [Asset](https://en.wikipedia.org/wiki/Asset) accounts
|
|
- Shared [asset accounts](https://en.wikipedia.org/wiki/Asset) ([household accounts](https://en.wikipedia.org/wiki/Household))
|
|
- Saving accounts
|
|
- Credit cards
|
|
- It's possible to create, change and manage money using _[budgets](https://en.wikipedia.org/wiki/Envelope_system)_;
|
|
- Organize transactions using categories;
|
|
- Save towards a goal using [piggy banks](https://en.wikipedia.org/wiki/Piggy_bank);
|
|
- Predict and anticipate [bills](https://en.wikipedia.org/wiki/Invoice);
|
|
- View income / expense [reports](https://en.wikipedia.org/wiki/Financial_statement);
|
|
- Organize expenses using tags;
|
|
- Lots of help text in case you don't get it.
|
|
|
|
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 charts because we all love them;
|
|
- Financial reporting showing you how well you are doing.
|
|
|
|
## Screenshots
|
|
|
|
_Please note that everything in these screenshots is fictional and may not be realistic._
|
|
|
|
![Index](https://i.nder.be/c09vfw90)
|
|
|
|
![Accounts](https://i.nder.be/hkn0vhcg)
|
|
|
|
![Budgets](https://i.nder.be/h2snx2mw)
|
|
|
|
![Reports 1](https://i.nder.be/c9f8zy5c)
|
|
|
|
![Reports 2](https://i.nder.be/ghvs5png)
|
|
|
|
![Bills](https://i.nder.be/h58kh00p)
|
|
|
|
![Piggy banks](https://i.nder.be/hkud0h53)
|
|
|
|
## Running and installing
|
|
|
|
If you're still interested please read [the installation guide](https://github.com/JC5/firefly-iii/wiki/Installation),
|
|
[the upgrade guide](https://github.com/JC5/firefly-iii/wiki/Upgrade-instructions) (if applicable)
|
|
and the **[first use guide](https://github.com/JC5/firefly-iii/wiki/First-use)**.
|
|
|
|
If you want to try out Firefly III, you can do so on [this dedicated website](https://geld.nder.be/).
|
|
This site always runs the latest version of Firefly III. If you want to use it, please read the [privacy considerations](https://github.com/JC5/firefly-iii/wiki/Privacy-on-demo-site) for this demo-site.
|
|
|
|
|
|
## Current state
|
|
|
|
Firefly III is pretty much all grown up. Full test coverage (nerd alert!) is coming. One of the things on the todo-list
|
|
is adding translations.
|
|
|
|
Questions, ideas, bugs or other things to contribute? [Let me know](https://github.com/JC5/firefly-iii/issues/new)!
|
|
|
|
If you like this tool, feel free to [donate me some beer money](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=2ZMV952UUSCLU&lc=NL&item_name=Development%20of%20Firefly¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted).
|
|
|
|
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/d44c7012-5f50-41ad-add8-8445330e4102/mini.png)](https://insight.sensiolabs.com/projects/d44c7012-5f50-41ad-add8-8445330e4102)
|
|
[![Code Climate](https://codeclimate.com/github/JC5/firefly-iii/badges/gpa.svg)](https://codeclimate.com/github/JC5/firefly-iii)
|
|
[![Project Status](http://stillmaintained.com/JC5/firefly-iii.png?a=b)](http://stillmaintained.com/JC5/firefly-iii)
|
|
[![Latest Stable Version](https://poser.pugx.org/grumpydictator/firefly-iii/v/stable.svg)](https://packagist.org/packages/grumpydictator/firefly-iii)
|
|
![GA](https://ga-beacon.appspot.com/UA-58172398-6/firefly-iii/readme)
|