Repository files navigation

Family Accounting Tool keeps track of every transaction your family makes. Its goal is to:

• Extract useful statistics from the data
  E.g.: How much is spent on food each month?
• Calculate internal debt
  E.g.: Alice buys toilet paper for the whole family with her own money. This tool then registersthat the family owes Alice the cost of the toilet paper.
• Provide a way to check if no money is disappearing in unexpected expenses
  E.g.: You will notice when there are hidden banking costs

• Install Java 11 (JDK 11) on your server
• Download "Binaries (compiled files) with demo configuration" from thelatestrelease
• Unpack the archive
• Openconf/application.conf in the unpacked folder:
  • Configure a database. The easiest way is to set up a MariaDB server locally,create an empty database calledfacto and configure it as follows:

db.default {  driver = com.mysql.jdbc.Driver  url = "jdbc:mysql://localhost/facto?user=mysqluser&password=mysqlpassword"  slick.profile = "slick.jdbc.MySQLProfile$"}

• Choose secret values forplay.http.secret.key andapp.setup.defaultPassword

• Open a terminal in the unpacked folder

• Run following commands to get the app running:

  # Create database tablesbin/server -DdropAndCreateNewDb# Create admin userbin/server -DcreateAdminUser# Run applicationbin/server

• Browse tohttp://localhost:9000/app/useradministration (username: "admin", password: "changeme")

Warning: The following works fine for launching a demo server to have a look.But if you want to run this as a service with real data and customconfiguration, it is recommended to follow the "Installation from release"section instead (seethis issuefor the reasons why).

The following commands will launch a new server alongside a database in Docker containers:

# Get the docker-compose.yml filewget https://raw.githubusercontent.com/nymanjens/facto/master/docker-compose.yml# Choose a unique random string here of sufficient lengthexport APPLICATION_SECRET="$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1)"# Create an empty database with a single admin userdocker-compose run web sleep 5 # Wait for the database to be readydocker-compose run web bin/server -DdropAndCreateNewDbdocker-compose run web bin/server -DcreateAdminUser# Bring up the serverdocker-compose up

When done, browse tohttp://localhost:9000/ (username: "admin", password: "changeme")

• conf/application.conf:
  Setup and configure a database here.
• Add users:
  A default user is created with the-DcreateAdminUser flag (username: admin, password:changeme). This account can create new users.
• conf/accounting-config.yml:
  Edit this file to reflect your situation and preferences. Note thatuserLoginName has to refer to a user that already exists in the database(see previous point)

To effectively use this tool, you must learn to input the transactions correctly. Therefore,it's important to understand the meaning of categories and accounts.

These are used to split up your expenses into categories. Every account has somespecial categories:

• Accounting category:
  Used for non-real income/expenses. This category will be ignored when analysing the monthlysurplus/deficit in terms of expenses. Use this category e.g. when the expense will be paidback by your employer
• Endowment category:
  Used for money transfer to the common account (see example in the next section)

An account can refer to a regular person or the common account.

Example:

A family has two members: Alice and Bob. There will be three accounts:

• Alice
• Bob
• The common account

Alice and Bob will regularly transfer money to the common account which can be used to makecommon expenses. This transfer to the common account is called an'endowment'.

Special fields:

• Beneficiary:
  In case of an expense: The one that will benefit from the expense
  In case of an income: The one that was paid
• Paid with/to:
  In case of an expense: Paid with
  In case of an income: Paid to
• Flow:
  In case of an expense: Negative number representing the price
  In case of an income: Positive number

The cash flow overview is a powerfull tool to check for unaccounted expenses.

You should:

• Set the current amount of money you have for every payment method (cash, card, ...).You can do this by using the"set" button.
• Whenever you perform a transaction, the balance will be updated automatically.
• You can re-count your cash and see if it matches the calculated value.If it does, you can use the checkbox button to mark this.If it doesn't, you have made an error or lost money.

This project was created and maintained by me (Jens) in my spare time for myfamily, and I made it open source in the hope that it might be useful forothers.

If you decide to use this, chances are you'll either be using it a lot, or stopusing it after some time. If you are in the former category, please send me amessage atnymanjens.nj@gmail.com (or considersending adonation) so I know others are usingthis. Definitely also let me know if you have any interest in upgrading to newerversions or using the more advanced (hidden) features like exchange rates andinflation correction.