Skip to content
Β 
Β 

Latest commit

Β 

History

208 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

FinBoard helps users manage budgets, monitor transactions, and analyze spending trends through interactive visualizations while keeping financial data organized and accessible.

React Vite Tailwind CSS Supabase

FinBoard Dashboard Preview

πŸ“Œ Table of Contents

  1. Features
  2. Privacy First
  3. Getting Started
  4. Local Development Setup
  5. Project Structure
  6. Tech Stack
  7. Contributing
  8. License

A retro-themed personal finance dashboard for budgeting, transaction tracking, and financial insights.

✨ Features

Interactive Dashboard
πŸ“Š Interactive Dashboard
Monitor your financial health at a glance with powerful real-time visualizations.
Budget Management
πŸ’° Budget Management
Set limits, track expenses per category, and work toward financial goals.
Transaction History
πŸ“œ Transaction History
Search, filter, and categorize transactions with complete visibility.
Financial Insights
🧠 Smart Insights
Identify spending patterns, income trends, and top categories over time.
Secure Local Data
βš™οΈ Finance Settings
Manage transactions, CSV upload, currency, and data reset options.

πŸ”’ Privacy First

Your financial data remains under your control.

  • Client-side experience with minimal external dependencies
  • CSV Import for transaction analysis and management
  • Multi-currency Support for flexible financial tracking
  • Secure storage options through the application's supported integrations

πŸš€ Getting Started

Prerequisites

  • Node.js v18 or higher
  • npm (included with Node.js)

Installation

# Clone the repository
git clone https://github.com/khanirfan18/finBoard.git

# Navigate into the project
cd finBoard

# Install dependencies
npm install

# Start the development server
npm run dev

Open:

http://localhost:5173

πŸ”§ Local Development Setup

FinBoard uses Supabase for authentication and data storage.

Before running the application locally, configure your Supabase project and environment variables by following the setup guide:

If you encounter:

Missing VITE_SUPABASE_URL or VITE_SUPABASE_ANON_KEY

make sure you have completed the Supabase setup steps and created the required .env file.


πŸ“ Project Structure

A modular React-based structure with clear separation of UI components, pages, state management, and utilities.

FINBOARD/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ assets/              # Static images and icons
β”‚   β”œβ”€β”€ components/          # Reusable UI components
β”‚   β”œβ”€β”€ context/             # Global state management (React Context)
β”‚   β”œβ”€β”€ data/                # Static/mock data
β”‚   β”œβ”€β”€ hooks/              # Custom React hooks
β”‚   β”œβ”€β”€ lib/                # Utilities, API config, helpers
β”‚   β”œβ”€β”€ pages/              # Application pages/routes
β”‚   β”‚   β”œβ”€β”€ Budgets.jsx
β”‚   β”‚   β”œβ”€β”€ Dashboard.jsx
β”‚   β”‚   β”œβ”€β”€ Goals.jsx
β”‚   β”‚   β”œβ”€β”€ InsightsDashboard.jsx
β”‚   β”‚   β”œβ”€β”€ Settings.jsx
β”‚   β”‚   └── Transaction.jsx
β”‚   β”œβ”€β”€ App.jsx             # Main app routing
β”‚   └── main.jsx            # Entry point
β”‚
β”œβ”€β”€ test/                   # Unit / utility tests
β”‚
β”œβ”€β”€ package.json            # Project dependencies & scripts
β”œβ”€β”€ vite.config.js          # Vite configuration
β”œβ”€β”€ index.html              # App root HTML
β”œβ”€β”€ netlify.toml            # Deployment config
β”œβ”€β”€ docker-compose.yml      # Docker support
β”œβ”€β”€ Dockerfile.*            # Docker build configs
β”œβ”€β”€ .env.example            # Environment variables template
β”œβ”€β”€ README.md
└── LICENSE

πŸ›  Tech Stack

Layer Technologies
Frontend React, React Router
Build Tool Vite
Styling Tailwind CSS, DaisyUI
Charts Recharts
Icons Lucide Icons, Custom SVGs
Backend / Database Supabase

🀝 Contributing

Contributions are welcome.

Before opening an issue or submitting a pull request, please review:

Guidelines

  • Follow the issue creation process outlined in the contribution guide
  • Claim tasks before beginning work
  • Align contributions with the project's scope and roadmap
  • Write clear and meaningful commit messages and pull request descriptions
  • Maintain respectful and constructive communication

Docker support is part of the long-term roadmap and is currently reserved for maintainer use. Docker-related contributions are out of scope unless explicitly requested by a maintainer.


πŸ“„ License

This project is licensed under the terms specified in the LICENSE file.

About

interactive personal finance dashboard to manage budgets, visualize transactions, and keep track of your spending securely in your browser.

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages