Skip to content

About

A modern, full-stack personal finance management application built with React, TypeScript, and Node.js. Track your income, expenses, budget goals, and savings with an intuitive and beautiful interface.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

Β 

History

37 Commits

Folders and files

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

Repository files navigation

πŸ’° Finance Flow

A modern, full-stack personal finance management application built with React, TypeScript, and Node.js. Track your income, expenses, budget goals, and savings with an intuitive and beautiful interface.

Finance Flow Dashboard

✨ Features

πŸ“Š Dashboard & Analytics

  • Real-time Overview: Get instant insights into your financial health
  • Interactive Charts: Visualize spending patterns and income trends
  • Smart Analytics: AI-powered financial insights and recommendations
  • Customizable Widgets: Arrange your dashboard to match your preferences

πŸ’³ Account Management

  • Multi-Account Support: Manage checking, savings, credit cards, and cash
  • Balance Tracking: Real-time balance updates across all accounts
  • Account Categories: Organize accounts by type and purpose
  • Transaction History: Detailed logs of all financial activities

πŸ’Έ Expense Tracking

  • Smart Categorization: Automatic expense categorization
  • Receipt Upload: Store and organize digital receipts
  • Recurring Expenses: Set up automatic recurring expense tracking
  • Expense Analytics: Detailed breakdown of spending patterns

πŸ’° Income Management

  • Multiple Income Sources: Track salary, freelance, investments, and more
  • Income Categories: Organize different types of income
  • Income Trends: Analyze income patterns over time
  • Tax Preparation: Export income data for tax purposes

🎯 Budget Goals

  • Smart Budgeting: Set realistic budget goals by category
  • Progress Tracking: Visual progress indicators for each goal
  • Monthly/Yearly Goals: Flexible time-based budgeting
  • Overspending Alerts: Get notified when approaching budget limits

🏦 Savings Goals

  • Goal Setting: Create and track multiple savings goals
  • Progress Visualization: See your progress towards each goal
  • Target Dates: Set deadlines for achieving your goals
  • Motivational Tracking: Celebrate milestones along the way

πŸ‘₯ Friend Transactions

  • Split Expenses: Easily split bills with friends and family
  • IOU Tracking: Keep track of money owed and owed to you
  • Payment Status: Mark transactions as completed
  • Friend Management: Organize transactions by person

πŸ’± Smart Currency & Hover Conversion

  • Hover-to-convert: Move your cursor over any monetary value to instantly preview it in your chosen target currency.
  • Sitewide currency: Set the default currency for the entire app based on your preference.
  • Conversion toggle: Turn the on-hover conversion behavior on or off anytime.
  • Target currency: Pick which currency is shown on hover when conversion is enabled.
  • Managed in Settings: Go to Settings β†’ Currency to configure preferences; they persist locally per device.

πŸ› οΈ Tech Stack

Frontend

  • React 18 - Modern UI library
  • TypeScript - Type-safe development
  • Vite - Fast build tool and dev server
  • Tailwind CSS - Utility-first CSS framework
  • shadcn/ui - Beautiful, accessible components
  • React Router - Client-side routing
  • React Hook Form - Form management
  • Recharts - Data visualization
  • ApexCharts - Advanced charting

Backend

  • Node.js - JavaScript runtime
  • Express.js - Web application framework
  • Prisma - Modern database ORM
  • PostgreSQL - Reliable relational database
  • JWT - Authentication and authorization
  • bcryptjs - Password hashing
  • Nodemailer - Email functionality

Development Tools

  • ESLint - Code linting
  • Prettier - Code formatting
  • TypeScript - Type checking
  • Vite - Development server

πŸ“‹ Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js (v18 or higher)
  • npm (comes with Node.js)
  • PostgreSQL (v14 or higher)
  • Git (for cloning the repository)

πŸš€ Installation Guide

1. Clone the Repository

git clone <your-repository-url>
cd Finanace-Flow-main

2. Install Frontend Dependencies

npm install

3. Install Backend Dependencies

cd backend
npm install

4. Set Up PostgreSQL Database

On Ubuntu/Debian:

sudo apt-get update
sudo apt-get install postgresql postgresql-contrib
sudo service postgresql start

On macOS (using Homebrew):

brew install postgresql
brew services start postgresql

On Windows:

Download and install PostgreSQL from the official website

5. Create Database and User

# Connect to PostgreSQL as superuser
sudo -u postgres psql

# Create database and user
CREATE DATABASE financeflow;
CREATE USER financeflow WITH PASSWORD 'financeflow123';
GRANT ALL PRIVILEGES ON DATABASE financeflow TO financeflow;
GRANT ALL ON SCHEMA public TO financeflow;
GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA public TO financeflow;
GRANT ALL PRIVILEGES ON ALL SEQUENCES IN SCHEMA public TO financeflow;

# Exit PostgreSQL
\q

6. Configure Environment Variables

Create a .env file in the backend directory:

cd backend
echo 'DATABASE_URL="postgresql://financeflow:financeflow123@localhost:5432/financeflow"' > .env
echo 'JWT_SECRET="your-super-secret-jwt-key-change-in-production"' >> .env
echo 'CONTACT_EMAIL_USER="[email protected]"' >> .env
echo 'CONTACT_EMAIL_PASS="your-app-password"' >> .env

7. Set Up Database Schema

# Generate Prisma client
npx prisma generate

# Push schema to database
npx prisma db push

8. Seed Sample Data (Optional)

# Create a sample user and populate with data
node seed-iron-man-data.js

πŸƒβ€β™‚οΈ Running the Application

Start the Backend Server

cd backend
npm run dev

The backend will be available at http://localhost:4000

Start the Frontend Development Server

# In a new terminal, from the project root
npm run dev

The frontend will be available at http://localhost:5173 (or the next available port like 8080, 8081, 8082, etc.)

πŸ‘€ Sample Login Credentials

For testing purposes, you can use these sample credentials:

Note: This account comes with 6 months of sample financial data including:

  • 11 different accounts (checking, savings, credit cards, cash)
  • 31 expense entries across various categories
  • 13 income entries from multiple sources
  • Budget goals and savings goals
  • Friend transactions

πŸ“± Usage

Getting Started

  1. Sign Up/Login: Create a new account or log in with existing credentials
  2. Add Accounts: Set up your bank accounts, credit cards, and cash accounts
  3. Track Income: Record your income sources and amounts
  4. Log Expenses: Add your daily expenses with categories
  5. Set Budget Goals: Create monthly budget targets for different categories
  6. Create Savings Goals: Set financial goals with target amounts and dates
  7. Manage Friends: Track money owed to and from friends

Currency Preferences

  • Preferred Currency: Controls the currency shown across the entire UI.
  • Enable Hover Conversion: When enabled, hovering a money value shows it in the target currency.
  • Target Currency: The currency used for the on-hover preview.

All of the above are configurable in Settings β†’ Currency.

Key Features

  • Dashboard: Get an overview of your financial health
  • Analytics: View detailed charts and insights
  • Accounts: Manage all your financial accounts
  • Expenses: Track and categorize your spending
  • Income: Record and analyze your income sources
  • Budget Goals: Set and monitor budget targets
  • Savings Goals: Track progress towards financial goals
  • Friends: Manage shared expenses and IOUs

πŸ—οΈ Project Structure

Finanace-Flow-main/
β”œβ”€β”€ src/                    # Frontend source code
β”‚   β”œβ”€β”€ components/         # React components
β”‚   β”œβ”€β”€ pages/             # Page components
β”‚   β”œβ”€β”€ hooks/             # Custom React hooks
β”‚   β”œβ”€β”€ lib/               # Utility functions and API
β”‚   └── ui/                # shadcn/ui components
β”œβ”€β”€ backend/               # Backend source code
β”‚   β”œβ”€β”€ prisma/            # Database schema and migrations
β”‚   β”œβ”€β”€ index.mjs          # Main server file
β”‚   └── seed-iron-man-data.js  # Sample data seeder
β”œβ”€β”€ public/                # Static assets
└── package.json           # Frontend dependencies

πŸ”§ Development

Available Scripts

Frontend

  • npm run dev - Start development server
  • npm run build - Build for production
  • npm run preview - Preview production build
  • npm run lint - Run ESLint

Backend

  • npm run dev - Start development server

Database Management

# Generate Prisma client after schema changes
npx prisma generate

# Push schema changes to database
npx prisma db push

# Open Prisma Studio (database GUI)
npx prisma studio

# Reset database (WARNING: deletes all data)
npx prisma db push --force-reset

πŸš€ Deployment

Frontend Deployment

The frontend can be deployed to any static hosting service:

  1. Build the application:

    npm run build
  2. Deploy the dist folder to your preferred hosting service:

    • Vercel
    • Netlify
    • GitHub Pages
    • AWS S3

Backend Deployment

The backend can be deployed to various platforms:

  1. Heroku:

    heroku create
    heroku addons:create heroku-postgresql
    git push heroku main
  2. Railway:

    • Connect your GitHub repository
    • Add PostgreSQL database
    • Deploy automatically
  3. DigitalOcean App Platform:

    • Connect your repository
    • Configure environment variables
    • Deploy with one click

🀝 Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ†˜ Support

If you encounter any issues or have questions:

  1. Check the Issues page
  2. Create a new issue with detailed information
  3. Contact the development team

πŸ™ Acknowledgments


Made with ❀️ for better financial management

About

A modern, full-stack personal finance management application built with React, TypeScript, and Node.js. Track your income, expenses, budget goals, and savings with an intuitive and beautiful interface.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages