Dough Tracker

PHP7, Slim, MongoDB, Angular 4, Bootstrap 4

Overview

An expenses tracker that helps you track your income and expenses by analyzing monthly credit card statements

• A parser for analyzing and categorizing data from financial statements (supported providers are Bank of America, Citizen and Discover)

• RESTful API for retrieving information

• A client for visualization personal balance and bills

User Guide

1. How much did you spend and earn by years

2. What was your balance in a particular month

2.1. (plus additional visualization for averages by category)

3. What was your statement in a particular month

Install Notes

Server

• Install dependencies:

  php composer install
  mkdir logs && chmod 777 logs
  

• Add an app config file (see an example in src/config/config.example.php):

  vi src/config/config.php
  

• Check out the main app log file:

  tail -f logs/app.log
  

• When using the parser, put your financial statements in /data:

  mkdir data && chmod 777 data
  

• How to run the parser see 'Utilities' section

• Note: For local machines: don't forget to configure an nginx / Apache virtual host if needed

• Note: To redefine parser's grouping categories update src/libs/Budget/Categorization/rules/credit_categ.php (or create a local credit_categ_local.php)

Client

• Install dependencies:

  cd client/
  npm install
  

• Make sure apiEndpoint variable is set to API URL:

  cd client/
  vi /src/environments/environment.local.ts
  # OR
  vi /src/environments/environment.prod.ts
  

• Run the client:

  cd client/ && ng serve --env=local
  

• Browse to http://localhost:4200

Utilities

Main parser utilities

• Parse all statements in the directory:

cd public && php cli.php /cli/parse-files GET

• Parse a statement after a statement

cd public && php cli.php /cli/parse-files GET file=*.CSV

Additional utils

cd public/
php cli.php /cli/recategorize GET
php cli.php /cli/output-titles GET

Naming convention

• "cit-" - Citizen statements prefix
• "boa-" - Bank of America statements prefix
• "dis-" - Discover statments prefix

API Endpoints

Note: Use GET method to retrieve data using the following properties with required properties in bold:

• Call data-groupby to get a sum that you spend/earn on a specified month

  Field	Description
  m	month
  y	year
  cg	category
  type	type: debit = 1 or credit = -1]

  For example, /api/data-groupby?m=1&y=2017&cg=rent

• Call data-details to get a list of all transactions that you made on a specified month

  Field	Description
  m	month
  y	year

  For example, /api/data-details?m=1&y=2017

• Call data-tableby to get a table of all sums by categories and/or years and/or months

  Field	Description
  m	month
  y	year

  For example, /api/data-tableby?y=2017

• Call categories to get a full list of categories

  For example, /api/categories