8000 GitHub - tham-le/mindful: MindfulWealth is a financial assistant application designed to help users make mindful spending decisions and encourage saving and investing.
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

MindfulWealth is a financial assistant application designed to help users make mindful spending decisions and encourage saving and investing.

Notifications You must be signed in to change notification settings

tham-le/mindful

Repository files navigation

MindfulWealth

MindfulWealth is a financial assistant application designed to help users make mindful spending decisions and encourage saving and investing.

Features

  • AI-Powered Chat: Interact with an AI financial assistant that helps you make better spending decisions
  • Impulse Purchase Analysis: Get insights on potential impulse purchases and their long-term financial impact
  • Investment Projections: See how your money could grow if invested instead of spent
  • Multiple Personality Modes: Choose between different advisor personalities (nice, funny, ironic)
  • Multilingual Support: Available in English and French

Visual Overview

Chat Interface The intuitive chat interface.

Dashboard in French Dashboard view in French, showcasing multilingual support.

Mobile Responsive Dashboard Mobile responsive design of the dashboard.

Profile Settings User profile and personality settings.

Getting Started

Prerequisites

  • Docker and Docker Compose (for production deployment)
  • Node.js 18+ and npm (for development)
  • Python 3.10+ (for development)
  • A valid Gemini API key from Google AI Studio
  • lsof (required for checking open ports in deployment/development scripts)
  • A text editor such as nano or vi (used by the setup scripts)
  • Ensure you have proper Docker permissions (your user should be in the docker group or use sudo)

Quick Start

For a quick start with all default settings, simply run:

./start.sh

This will set up and start the application in production mode.

Development Setup

For local development:

./dev.sh

This script will guide you through setting up the development environment.

Architecture

MindfulWealth consists of two main components:

  1. Backend: A Flask API that handles:

    • User authentication
    • Integration with Google's Gemini AI
    • Financial data processing
    • Database operations
  2. Frontend: A React application that provides:

    • User interface for chat interactions
    • Financial dashboard
    • Settings management
    • Responsive design for mobile and desktop

Deployment

For detailed deployment instructions, see DEPLOYMENT.md.

Port Configuration

The application uses the following ports by default:

  • Port 80: Main frontend access
  • Port 3000: Alternative frontend access
  • Port 5000: Backend API

If any of these ports are already in use on your system, see the deployment guide for configuration options.

Chat Functionality

For information about the chat functionality and recent fixes, see CHAT_FIXES.md.

Contributing

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

License

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

Acknowledgments

  • Google Gemini API for powering the AI assistant
  • Flask and React communities for their excellent frameworks
  • All contributors to this project

About

MindfulWealth is a financial assistant application designed to help users make mindful spending decisions and encourage saving and investing.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  
0