https://github.com/markmhendrickson/foreceipt-analyzer
App to analyze transaction data stored by Foreceipt http://www.foreceipt.com/
https://github.com/markmhendrickson/foreceipt-analyzer
finances foreceipt personal-finance
Last synced: 3 days ago
JSON representation
App to analyze transaction data stored by Foreceipt http://www.foreceipt.com/
- Host: GitHub
- URL: https://github.com/markmhendrickson/foreceipt-analyzer
- Owner: markmhendrickson
- Created: 2018-03-17T13:43:42.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-07-06T20:59:10.000Z (almost 4 years ago)
- Last Synced: 2025-03-05T05:43:11.757Z (about 1 year ago)
- Topics: finances, foreceipt, personal-finance
- Language: JavaScript
- Size: 10.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Foreceipt analyzer
This repository contains the source code for a script that analyzes all transaction files stored by [Foreceipt](http://www.foreceipt.com/) in Google Drive and outputs various insights.
I created it to better understand my monthly manual expenditures, particularly those falling within my food and discretionary budgets, to know just how much I've been over- or under-spending.
## Setting up the environment
The code requires the following environment variables to run. The following environment variables can be declared by adding a file named `.env` (in [INI format](https://en.wikipedia.org/wiki/INI_file)) to the base directory, assuming they're not declared elsewhere in the system already. Such a file will be ignored by Git.
- `FORECEIPT_ANALYZER_DISCRETIONARY_BUDGET`: Size of monthly discretionary budget in euros (e.g. `500`)
- `FORECEIPT_ANALYZER_FOOD_BUDGET`: Size of monthly food budget in euros (e.g. `300`)
- `FORECEIPT_ANALYZER_DIR`: System path to Google Drive folder created by Foreceipt (e.g. `/Users/username/Google Drive/Foreceipt`)
## Running the script
Once the environment is ready per above, and [Node.js](http://nodejs.org/) with [NPM](https://www.npmjs.com/) is installed, simply run `npm install` to install dependencies and `node index.js` to run the script.