Note: the below stuff is the instructions from the original author with documentation of my own added in. In my opinion, my version has more features and generally meets the financial needs of most people better.

NOTE: I update this documentation on demand when people ask me to. Unless you've talked to me, I make no assurances this is up to date (in fact, I can probably assure the opposite). Open an issue and I'll update this.

Build Your Own Mint

Important Disclaimer

All this repo does is talking to Plaid/Google APIs and writing tokens to your local file system. If you don't feel safe entering real bank credentials, audit the code yourself to make sure.

Setting up API keys

First things first - rename .env.sample to .env. Variables in this file will be loaded as environment variables. This file is ignored by Git.

Plaid

You will first need to sign up for Plaid and apply for the development plan. You might need to wait for a day or two to get approved. It's free and limited to 100 items (i.e. banks), so it should be more than enough for your personal use.
Once approved, fill out the following in .env:
- PLAID_CLIENT_ID
- PLAID_SECRET
Now you need to connect to your financial institutions to generate access tokens.

Run npm run token-plaid <account> where account is an id for the bank you want to connect (it's for your personal reference, so you can name it anything). This will start a local server which you can visit in your browser and go through the authentication flow. Once you've linked the bank, its associated access token will be saved in .env.

This process needs to be repeated for each bank you want to connect. Make sure to run each with a different account name.
If you've done everything correctly, running npm run test-plaid now should log the recent transactions in your connected accounts.

Google Sheets

I use a Google Sheet because it's convenient. If you don't trust Google or want to build your own fancy interface, you can totally do that - but that's out of scope for this project.

First, create a Google Sheets spreadsheet, and save its ID in .env as SHEETS_SHEET_ID.
Then, go to Google Sheets API Quickstart, and click the "Enable the Google Sheets API" button. Follow instructions and download the credentials JSON file. Take a look at the file and fill in the following fields in .env:
- SHEETS_CLIENT_ID
- SHEETS_CLIENT_SECRET
- SHEETS_REDIRECT_URI (use the first item in redirect_uri)
Run npm run token-sheets. This will prompt for auth and save the token in .env.
Now run npm run test-sheets. You should see your sheet's cell A1 with "It worked!".

Transform your Data

Note: the exact sheet names here are very important.

I've already written the transform logic for the repo. You want to have your spreadsheet contain two sheets. One of them (called transactions) should have the following headers: Date,Account,Description,Amount,Type,Category1,Category2,Category3,Category4,Device,Time Retrieved.

You should have another sheet (called balances). This one is a little more tricky. Run npm run get-private. It should give an error but before it does, it should print out an array of your bank accounts that should look familiar to you. You can have multiple accounts per institutions (i.e. if you have a credit card and a checking account from a bank).

Now, create a json that has each account's name (exactly as it appears) as the key and a unique column (anything that is C or greater) in the balances sheets as the value. This column is where that institution's balance will be printed. It should look something like this:

{
    "Account1": "C",
    "Account2": "D",
    ... etc
}

This JSON shows where each account goes in the sheet. Now, create a file at lib/accounts.secret.ts. That file should look like this:

/* eslint-disable */
export default {
    "Account1": "C",
    "Account2": "D",
}

After this, npm run get-private AND npm run get should populate the transactions and balances sheet whenever it's run. Note that npm run get logs no private information which is helpful if you use the CI feature below on a free plan. get-private does log private information and should be used only on trusted machines.

Texting

This is a totally optional feature. If you don't want it, set ENABLE_SMS to false and you can stop reading. Note that it costs around $1.20 a month.

If you are interested, go create a Twilio account and follow the instructions here. Then, set the environment variables that start with TWILIO in your .env to your Twilio account credentials. Set USER_PHONE_NUMBER to the number that should be texted. Finally, set ENABLE_SMS to true.

This feature will text you everytime the script is run. It works best with CircleCI (below). I've found it helpful for displining my spending by forcing me to be aware of how much I have and am spending.

You will be texted only if ENABLE_SMS is "true" OR you're in a "nightly" CircleCi job and ENABLE_SMS is not "false".

Automate the Updates

The repo contains a CircleCI config file which runs the update every day at 14PM UTC (8AM America/Chicago).

This is totally optional if you don't trust CI with your tokens. Just run it manually when you want to update things. If you do want to use CircleCI, here's how:

Change the time (if you'd like) in the .circleci/config.yml file.
Set your GitHub username, project name, and default branch name in the env file
Delete ./accounts.public.txt
Set up the basic project in CircleCI and run it. It should fail.
Get an API token from CircleCI and set it in the env file
Create a random string and set it to ACCOUNTS_PASSWORD.
Run npm run push-env to sync over your environment to the CircleCI environment
Run ts-node scripts/encryptSecret.ts. This will use your ACCOUNTS_PASSWORD to encrypt your account mapping (the thing you made earlier in lib/accounts.secret.ts) and write it to ./accounts.public.txt. Since it's encrypted, no one can read it without your ACCOUNTS_PASSWORD even though it'll be public.
git push

As your Plaid tokens expire, you can always push-env. As you get rid of or get new bank accounts, change your secret bank account mapping, encrypt it, and push it.

bencooper222/build-your-own-mint