firefly-iii/README.md
2017-12-13 14:15:44 +01:00

5.2 KiB
Raw Blame History

Firefly III: A personal finances manager

Requires PHP7.1 Latest Stable Version License Donate

The index of Firefly III The account overview of Firefly III

The useful financial reports of Firefly III Saving money is easy!

"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 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 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.

Using Heroku

Deploy

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

My Heroku configuration is currently broken, but I'm trying to fix it.

Using Sandstorm.io

You can find Firefly III in the Sandstorm.io marketplace. 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", its just somebody elses 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.

Contributing

Please read CONTRIBUTING.md for details on contributing, and the process for submitting pull requests. Please check out the code of conduct as well.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

License

This work is licensed under the GPL v3.

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 (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.

Build Status Scrutinizer Code Quality Coverage Status