firefly-iii/README.md

60 lines
4.5 KiB
Markdown
Raw Normal View History

2016-12-19 10:31:23 -06:00
# Firefly III: A personal finances manager
2017-02-22 10:58:57 -06:00
[![Requires PHP7](https://img.shields.io/badge/php-7.0-red.svg)](https://secure.php.net/downloads.php) [![Latest Stable Version](https://poser.pugx.org/grumpydictator/firefly-iii/v/stable)](https://packagist.org/packages/grumpydictator/firefly-iii) [![License](https://img.shields.io/badge/license-CC%20BY--SA%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by-sa/4.0/) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=44UKUT455HUFA)
2016-01-09 07:33:21 -06:00
2016-12-15 01:16:34 -06:00
[![The index of Firefly III](https://i.nder.be/hurdhgyg/400)](https://i.nder.be/h2b37243) [![The account overview of Firefly III](https://i.nder.be/hnkfkdpr/400)](https://i.nder.be/hv70pbwc)
2016-05-18 07:22:48 -05:00
2016-12-15 01:16:34 -06:00
[![The useful financial reports of Firefly III](https://i.nder.be/h7sk6nb7/400)](https://i.nder.be/ccn0u2mp) [![Even more useful reports in Firefly III](https://i.nder.be/g237hr35/400)](https://i.nder.be/gm8hbh7z)
2016-05-18 00:23:11 -05:00
"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.
2016-12-26 02:50:28 -06:00
## Try it out!
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/firefly-iii/firefly-iii/tree/master)
2016-12-26 02:50:28 -06:00
Firefly III can be run on Heroku. Register for a free Heroku account and instantly run Firefly III on your very own cloud instance. There is also a [demo site](https://firefly-iii.nder.be) with an example financial administration already present.
2017-04-28 13:07:26 -05:00
## Getting started
2016-05-18 00:23:11 -05:00
To install Firefly III, you'll need a web server (preferrably on Linux) and access to the command line. Then, please read the [installation guide](https://firefly-iii.github.io/using-installing.html).
2016-05-18 00:23:11 -05:00
## More about Firefly III
2014-11-09 04:10:57 -06:00
2016-01-21 06:56:08 -06:00
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.
2016-01-19 12:59:32 -06:00
2016-01-21 06:56:08 -06:00
Firefly works on the principle that if you know where you're money is going, you can stop it from going there.
### Some advantages of using Firefly
2016-01-21 06:56:08 -06:00
- Firefly can import any CSV file, so migrating from other systems is easy.
2016-01-30 01:42:04 -06:00
- Firefly runs on your own server, so you are fully in control of your data. Remember, there is no such thing as "the cloud", its just somebody elses computer!
2017-02-16 15:30:57 -06:00
- Firefly has lots of features without being fancy or bloated.
2016-01-21 06:56:08 -06:00
- If you feel you're missing something you can just ask me and I'll add it!
2016-11-09 04:04:14 -06:00
Firefly is pretty awesome. [You can read more about Firefly III, and its features, on the Github Pages](https://firefly-iii.github.io/).
2016-05-18 00:23:11 -05:00
### Contributing
2017-06-30 00:22:12 -05:00
Please read [CONTRIBUTING.md](https://github.com/firefly-iii/firefly-iii/blob/master/.github/CONTRIBUTING.md) for details on contributing, and the process for submitting pull requests. Please check out the [code of conduct](https://github.com/firefly-iii/firefly-iii/blob/master/CODE_OF_CONDUCT.md) as well.
### Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see [the tags](https://github.com/firefly-iii/firefly-iii/tags) on this repository.
### Authors
* James Cole
* Over time, [many people have contributed to Firefly III](https://github.com/firefly-iii/firefly-iii/graphs/contributors).
### License
This work [is licensed](https://github.com/firefly-iii/firefly-iii/blob/master/LICENSE) under a [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/).
### Other stuff
2016-12-19 10:31:23 -06:00
If you like Firefly and if it helps you save lots of money, why not send me [a dime for every dollar saved](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=44UKUT455HUFA) (this is a joke, although the Paypal form works just fine, try it!)
2016-12-19 10:24:15 -06:00
2016-11-09 04:04:14 -06:00
If you want to contact me, please open an issue or [email me](mailto:thegrumpydictator@gmail.com).
2017-02-22 10:58:57 -06:00
2017-03-21 08:24:10 -05:00
[![Build Status](https://travis-ci.org/firefly-iii/firefly-iii.svg?branch=master)](https://travis-ci.org/firefly-iii/firefly-iii) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/firefly-iii/firefly-iii/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/firefly-iii/firefly-iii/?branch=master) [![Coverage Status](https://coveralls.io/repos/github/firefly-iii/firefly-iii/badge.svg?branch=master)](https://coveralls.io/github/firefly-iii/firefly-iii?branch=master)