FinBoard helps users manage budgets, monitor transactions, and analyze spending trends through interactive visualizations while keeping financial data organized and accessible.
- Features
- Privacy First
- Getting Started
- Local Development Setup
- Project Structure
- Tech Stack
- Contributing
- License
A retro-themed personal finance dashboard for budgeting, transaction tracking, and financial insights.
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
- Node.js v18 or higher
- npm (included with Node.js)
# 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 devOpen:
http://localhost:5173
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.
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
| Layer | Technologies |
|---|---|
| Frontend | React, React Router |
| Build Tool | Vite |
| Styling | Tailwind CSS, DaisyUI |
| Charts | Recharts |
| Icons | Lucide Icons, Custom SVGs |
| Backend / Database | Supabase |
Contributions are welcome.
Before opening an issue or submitting a pull request, please review:
- 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.
This project is licensed under the terms specified in the LICENSE file.




