Streaks For YNAB

A web app for tracking spending habits with YNAB.

Built on SvelteKit.

For any bug reports or feature requests, visit the issues page.

Local Development

1. Fork and clone

git clone https://github.com/YOUR-USERNAME/streaksforynab.git
cd streaksforynab

2. Install packages: pnpm install
3. Copy .env.example to .env

cp .env.example .env

You should see this .env:

PUBLIC_ADAPTER='static'
PUBLIC_BASE_PATH='/streaksforynab'
PUBLIC_YNAB_CLIENT_ID='your-ynab-client-id-here'

Make sure to edit the values in your .env file. The defaults are set for my GitHub pages site, where PUBLIC_YNAB_CLIENT_ID should be edited. The official Oauth Client App won't accept local dev urls as callbacks, so you'll have to make your own at YNAB Developer Settings.

Click "New Application" and enter details for your fork.

In the "Redirect URI(s) text box, you should input your local server url + '/callback' (e.g., http://localhost:5173/callback).

Click Save Application, and then copy the Client ID and paste it as the value for PUBLIC_YNAB_CLIENT_ID.

4. Run the server: pnpm dev

Some changes may not show for dev. To catch these, run pnpm build and then run pnpm preview to preview how the app would work on a Production-esque environment. You must run pnpm build each time you make changes (unlike with pnpm dev, which auto-refreshes).

What is this?

Streaks For YNAB allows you to track your spending in the form of habits. Basically, you can write something like "Under $15 Restaurants" and it will use your YNAB transactions to track how often you spend over $15 on Restaurants.

Your goal is to continue the streak as much as possible and avoid being in the red.

See a list of all your habits, with indicators for how close you are to breaking them today:

Finely tune what kinds of transactions you want to include in your habit with filtering:

View a calendar and other stats for any habit:

Important Details To Consider

For information on how your YNAB data is received and stored, view the privacy policy.

[!IMPORTANT] At this time, there is no automatic sync engine to backup your habit data to a server database on any of my deployments of this code.

Your data is stored 100% locally on your browser for the given domain (.e.g, https://danielh-official.github.io/streaksforynab).

YNAB transactions are property of YNAB and can always be retrieved again via the API, but habits are stored locally on your browser for the specific domain you're using.

You may export your habits if you intend to:

• Use a different browser/computer
• Use this codebase on a different domain

And then import them into the new location.

Exporting ignores transactions and any other data that belong to YNAB to ensure the process is fast, so fresh imports will require a fresh fetch from YNAB via "Fetch Transactions For Budget".

As this instance of Streaks For YNAB is open-source, you may fork this repository at any time, add any features or improvements, and deploy your own version to your own domain (e.g., mypersonaldeploymentofstreaksforynab.netlify.app).