Skip to content

maxiwoj/personal-finance-explorer-rs

Repository files navigation

Personal Finance Explorer

Personal Finance Explorer Logo

Deploy with Vercel

A powerful, privacy-focused personal finance dashboard that turns your Google Sheets into a rich, interactive explorer. Built with Next.js, Google OAuth 2.0, and high-performance charting.

Live Demo

Dashboard Overview

Try the Live Demo

Want to see the app in action? Visit the live demo to experience the full functionality with sample data.

Note: The demo is deployed with sample data for demonstration purposes. Currently, to use your own financial data, you should deploy your own instance with your Google Sheet.

Features

  • Google Sheets Integration: Directly syncs with your Google Spreadsheet. The app does not store any of your data on its servers.
  • Interactive Dashboard: Get a high-level overview of your spending, income, and net flow with dynamic charts.
  • Detailed Transaction Explorer: Search, filter, and drill down into every transaction.
  • Multi-dimensional Filtering: Filter by date range, month/year, and categories.
  • Privacy First: Authenticate with Google OAuth and keep your data in your own spreadsheet.

Screenshots

Transactions Explorer

Transactions Explorer

Finance Analysis

Categories

Categories

Category Deep Dive

Category Deep Dive

Development getting started

Prerequisites

  • Node.js 18.x or later
  • A Google Cloud Project with the Google Sheets API enabled
  • A Google Spreadsheet with your financial data

Development

  1. Clone the repository:

    git clone https://github.com/your-username/personal-finance-explorer-rs.git
    cd personal-finance-explorer-rs
  2. Install dependencies:

    pnpm install
  3. Configure Environment Variables: Create a .env.local file in the root directory and add the following:

    NEXT_PUBLIC_GOOGLE_CLIENT_ID=your_client_id
    NEXT_PUBLIC_SPREADSHEET_ID=your_spreadsheet_id
    NEXT_PUBLIC_REDIRECT_URI=http://localhost:3000
    GOOGLE_CLIENT_SECRET=your_client_secret

    For detailed setup instructions, see the Deployment Guide.

  4. Run the development server:

    set -a; source .env.local; set +a
    pnpm dev

    Open http://localhost:3000 to see the application.

📖 Documentation

🚀 Quick Deployment

One-Click Vercel Deployment

Deploy with Vercel

Deploy your own instance of this app with just one click! Simply click the "Deploy with Vercel" button above, and follow these steps:

  1. Sign in to your Vercel account (or create one if you don't have it)
  2. Connect your GitHub account when prompted
  3. Fill in the required environment variables:
    • NEXT_PUBLIC_GOOGLE_CLIENT_ID: Your Google OAuth Client ID
    • NEXT_PUBLIC_SPREADSHEET_ID: Your Google Spreadsheet ID
    • GOOGLE_CLIENT_SECRET: Your Google OAuth Client Secret
    • NEXT_PUBLIC_REDIRECT_URI: Your Vercel deployment URL (will be auto-filled)
  4. Click "Deploy" and your app will be live in minutes!

For detailed setup instructions, see the Setup & Deployment Guide.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

About

A simple, Google Sheet based, Personal Finance Explorer

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors