Peek for YNAB

A browser extension for YNAB that lets users see their category and account balances at a glance, quickly add transactions, setup customizable notifications, and more. See full feature list and installation links on the extension website.

Project layout

• extension/ Browser extension using WXT, React, and TypeScript
  • src/
    • components/ React components
    • entrypoints/ Extension popup page, options page, and background script
    • lib/ Library and utility functions
    • styles/ Extension CSS / Sass styles
  • test/ Unit tests with Vitest
• web/ Website and server using Astro and Fastify
  • server/ Fastify server (OAuth flow, API routes, and Astro static files)
    • routes/ API routes
  • src/
    • pages/ All website pages (Astro)

Building and running locally

You must have Node.js (>= 22) and pnpm installed before proceeding.

Environment variables

Set up an OAuth application in your YNAB Developer Settings. Then, in both the extension/ and web/ directories, copy the .env.example file to .env and fill in the values.

Backend / Web

The server and website is created with Fastify and Astro. The server is located in the /web/server folder, and the web pages are located in the web/src/pages folder. You can run the server via:

cd web
pnpm install
pnpm build
pnpm start

Extension

This extension is developed using the WXT framework. To run the extension's development server, make sure the Astro server (see above) is running and then run:

cd extension
pnpm install
pnpm dev

A development browser should open automatically and load the extension.

Building for production

Extension

cd extension
pnpm build

The extension will be built to the extension/build/chrome-mv3 folder. This can be loaded into Chrome by navigating to chrome://extensions/ and clicking "Load unpacked".

Backend / Web

cd web
pnpm build

The Astro backend and website will be built as an Express-compatible middleware to the web/dist/ folder. You can then run the Fastify server via:

pnpm start