firefly-iii/README.md

# Firefly III: A personal finances manager 

[![Requires PHP7.1](https://img.shields.io/badge/php-7.1-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-GPL-lightgrey.svg)](https://www.gnu.org/licenses/gpl.html) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=44UKUT455HUFA) 

[![The index of Firefly III](https://i.nder.be/ccynyxy0/400)](https://i.nder.be/h327vx3y) [![The account overview of Firefly III](https://i.nder.be/g8v86y2g/400)](https://i.nder.be/hkpynqr9)

[![The useful financial reports of Firefly III](https://i.nder.be/cs3qx4f3/400)](https://i.nder.be/cwznmryd) [![Saving money is easy!](https://i.nder.be/gpq6ykym/400)](https://i.nder.be/gum2qf8z)

"Firefly III" is a financial manager for your personal finances. It can help you keep track of your expenses and income.
Firefly III supports the use of budgets. You can categorize and tag your transactions.
It also supports credit cards, shared  household accounts and savings accounts.
There are many financial reports available.

## Want to try Firefly III?

There is a **[demo site](https://demo.firefly-iii.org)** with an example financial administration already present. You can use Docker, Heroku or Sandstorm.io (see below) to quickly setup your own instance.

## Install Firefly III

### Using docker

You can use docker-compose to [set up your personal secure](https://firefly-iii.org/using-docker.html) Firefly III environment. Advanced users can use the Dockerfile directly. 

### Using vagrant (or other VMs)

You can install Firefly III on any Linux or Windows machine. You'll need a web server (preferrably on Linux) and access to the command line. Please read the [installation guide](https://firefly-iii.org/using-installing.html).

### Using Heroku

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/firefly-iii/firefly-iii/tree/master)

Register for a free Heroku account and instantly run Firefly III on your very own cloud instance.

### Using Sandstorm.io

You can find Firefly III in [the Sandstorm.io marketplace](https://apps.sandstorm.io/app/uws252ya9mep4t77tevn85333xzsgrpgth8q4y1rhknn1hammw70). You can run it on your own installation or on Oasis.

## More about Firefly III

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.

### Some advantages of using Firefly

- Firefly can import any CSV file, so migrating from other systems is easy.
- Firefly runs on your own server, so you are fully in control of your data. Remember, there is no such thing as "the cloud", it’s just somebody else’s computer!
- Firefly has lots of features without being fancy or bloated.
- If you feel you're missing something you can just ask me and I'll add it!

Firefly III has become pretty awesome over the years! (but please excuse me for bragging, it's just that I'm proud of it).
[You can read more about Firefly III, and its features, on the website](https://firefly-iii.org/).

### Contributing

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 the [GPL v3](https://www.gnu.org/licenses/gpl.html).

### Other stuff

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!)

If you want to contact me, please open an issue or [email me](mailto:thegrumpydictator@gmail.com).

[![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)
-												Expand read me [skip ci]

											
										
										
											2016-12-19 10:31:23 -06:00
+								# Firefly III: A personal finances manager
-												New packages, updated read me, new composer.lock

											
										
										
											2015-06-29 09:42:38 -05:00
-												New copyright notice.

											
										
										
											2017-10-21 01:40:00 -05:00
+								[![Requires PHP7.1](https://img.shields.io/badge/php-7.1-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-GPL-lightgrey.svg)](https://www.gnu.org/licenses/gpl.html) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=44UKUT455HUFA)
-												Cleared read me. [skip-ci]

											
										
										
											2016-01-09 07:33:21 -06:00
-												Updated read me file. [skip ci]

											
										
										
											2017-10-20 03:07:53 -05:00
+								[![The index of Firefly III](https://i.nder.be/ccynyxy0/400)](https://i.nder.be/h327vx3y) [![The account overview of Firefly III](https://i.nder.be/g8v86y2g/400)](https://i.nder.be/hkpynqr9)
-												New read me. [skip ci]

											
										
										
											2016-05-18 07:22:48 -05:00
-												Updated read me file. [skip ci]

											
										
										
											2017-10-20 03:07:53 -05:00
+								[![The useful financial reports of Firefly III](https://i.nder.be/cs3qx4f3/400)](https://i.nder.be/cwznmryd) [![Saving money is easy!](https://i.nder.be/gpq6ykym/400)](https://i.nder.be/gum2qf8z)
-												New screenshots [skip ci]

											
										
										
											2016-12-15 01:16:34 -06:00
-												Updated read me file. [skip ci]

											
										
										
											2017-10-20 03:06:13 -05:00
+								"Firefly III" is a financial manager for your personal finances. It can help you keep track of your expenses and income.
-												Improve readme [skip ci]

											
										
										
											2017-09-25 00:40:49 -05:00
+								Firefly III supports the use of budgets. You can categorize and tag your transactions.
 								It also supports credit cards, shared  household accounts and savings accounts.
 								There are many financial reports available.
-												Updated read me [skip ci]

											
										
										
											2016-05-18 00:23:11 -05:00
-												Updated read me file. [skip ci]

											
										
										
											2017-10-20 03:06:13 -05:00
+								## Want to try Firefly III?
-												Update read me [skip ci]

											
										
										
											2016-12-26 02:50:28 -06:00
-												Update links to new site.

											
										
										
											2017-12-13 07:15:44 -06:00
+								There is a **[demo site](https://demo.firefly-iii.org)** with an example financial administration already present. You can use Docker, Heroku or Sandstorm.io (see below) to quickly setup your own instance.
-												Updated read me file. [skip ci]

											
										
										
											2017-10-20 03:06:13 -05:00
 								## Install Firefly III
 								### Using docker
-												More text about Heroku.

											
										
										
											2017-04-28 13:07:26 -05:00
-												Update links to new site.

											
										
										
											2017-12-13 07:15:44 -06:00
+								You can use docker-compose to [set up your personal secure](https://firefly-iii.org/using-docker.html) Firefly III environment. Advanced users can use the Dockerfile directly.
-												Updated read me [skip ci]

											
										
										
											2016-05-18 00:23:11 -05:00
-												Updated read me file. [skip ci]

											
										
										
											2017-10-20 03:06:13 -05:00
+								### Using vagrant (or other VMs)
-												Update links to new site.

											
										
										
											2017-12-13 07:15:44 -06:00
+								You can install Firefly III on any Linux or Windows machine. You'll need a web server (preferrably on Linux) and access to the command line. Please read the [installation guide](https://firefly-iii.org/using-installing.html).
-												Updated read me file. [skip ci]

											
										
										
											2017-10-20 03:06:13 -05:00
 								### Using Heroku
 								[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/firefly-iii/firefly-iii/tree/master)
-												Updated read me [skip ci]

											
										
										
											2016-05-18 00:23:11 -05:00
-												Updated readme.

											
										
										
											2017-10-21 13:50:15 -05:00
+								Register for a free Heroku account and instantly run Firefly III on your very own cloud instance.
-												Add sandstorm reference to read me.

											
										
										
											2017-10-21 13:46:34 -05:00
+								### Using Sandstorm.io
 								You can find Firefly III in [the Sandstorm.io marketplace](https://apps.sandstorm.io/app/uws252ya9mep4t77tevn85333xzsgrpgth8q4y1rhknn1hammw70). You can run it on your own installation or on Oasis.
-												Updated read me [skip ci]

											
										
										
											2016-05-18 00:23:11 -05:00
+								## More about Firefly III
-												Updated readme file.

											
										
										
											2014-11-09 04:10:57 -06:00
-												Improve readme [skip ci]

											
										
										
											2017-09-25 00:40:49 -05: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.
-												Updated read me.

											
										
										
											2016-01-19 12:59:32 -06:00
-												Updated readme. [skip ci]

											
										
										
											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.
-												Updated read me and contributing guidelines.

											
										
										
											2017-06-28 08:17:19 -05:00
+								### Some advantages of using Firefly
-												Updated readme. [skip ci]

											
										
										
											2016-01-21 06:56:08 -06:00
 								- Firefly can import any CSV file, so migrating from other systems is easy.
-												Added some new lines to files.

											
										
										
											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", it’s just somebody else’s computer!
-												Small fix in read me [skip ci]

											
										
										
											2017-02-16 15:30:57 -06:00
+								- Firefly has lots of features without being fancy or bloated.
-												Updated readme. [skip ci]

											
										
										
											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!
-												Improve readme [skip ci]

											
										
										
											2017-09-25 00:40:49 -05:00
+								Firefly III has become pretty awesome over the years! (but please excuse me for bragging, it's just that I'm proud of it).
-												Update links to new site.

											
										
										
											2017-12-13 07:15:44 -06:00
+								[You can read more about Firefly III, and its features, on the website](https://firefly-iii.org/).
-												Updated read me [skip ci]

											
										
										
											2016-05-18 00:23:11 -05:00
-												Updated read me and contributing guidelines.

											
										
										
											2017-06-28 08:17:19 -05:00
+								### Contributing
-												CoC. [skip ci]

											
										
										
											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.
-												Updated read me and contributing guidelines.

											
										
										
											2017-06-28 08:17:19 -05:00
 								### 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
-												New copyright notice.

											
										
										
											2017-10-21 01:40:00 -05:00
+								This work [is licensed](https://github.com/firefly-iii/firefly-iii/blob/master/LICENSE) under the [GPL v3](https://www.gnu.org/licenses/gpl.html).
-												Updated read me and contributing guidelines.

											
										
										
											2017-06-28 08:17:19 -05:00
 								### Other stuff
-												Expand read me [skip ci]

											
										
										
											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!)
-												Expand read me [skip ci]

											
										
										
											2016-12-19 10:24:15 -06:00
-												New website
											
										
										
											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).
-												Small updates to read me [skip ci]

											
										
										
											2017-02-22 10:58:57 -06:00
-												Update README.md

New badge
											
										
										
											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)