Skip to content

dewanshshekhar/BrainWaveDTU-Data-Dudes-

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

7 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

AI-Powered Personal Finance Assistant

A modern, responsive financial dashboard built with React and Tailwind CSS, featuring dark mode support and real-time data visualization.

Project Status License

๐ŸŒŸ Features

  • ๐Ÿ” Secure authentication system with login/signup flows
  • ๐ŸŒ“ Dark mode support with system preference detection
  • ๐Ÿ“Š Interactive charts using Recharts
  • ๐Ÿ’ณ Credit card management interface
  • ๐Ÿ“ฑ Fully responsive designs
  • ๐Ÿ“ˆ Financial analytics and reporting
  • ๐ŸŽจ Modern UI with Tailwind CSS
  • ๐Ÿ” Search functionality
  • ๐Ÿ“ฑ Mobile-friendly layout

๐Ÿš€ Tech Stack

  • React
  • Tailwind CSS
  • Recharts for data visualization
  • Lucide React for icons
  • React Hooks for state management

๐Ÿ“‹ Prerequisites

Before you begin, ensure you have installed:

  • Node.js (v14.0.0 or higher)
  • npm (v6.0.0 or higher)

๐Ÿ› ๏ธ Installation

  1. Clone the repository
git clone https://github.com/yourusername/mymoney-dashboard.git
  1. Navigate to the project directory
cd mymoney-dashboard
  1. Install dependencies
npm install
  1. Start the development server
npm run dev

The application will be available at http://localhost:3000

๐Ÿ—๏ธ Project Structure

src/
โ”œโ”€โ”€ components/         # Reusable components
โ”‚   โ”œโ”€โ”€ Dashboard/     # Dashboard-specific components
โ”‚   โ”œโ”€โ”€ Auth/          # Authentication components
โ”‚   โ””โ”€โ”€ UI/            # Common UI components
โ”œโ”€โ”€ hooks/             # Custom React hooks
โ”œโ”€โ”€ styles/            # CSS and Tailwind configurations
โ””โ”€โ”€ utils/             # Utility functions

๐Ÿ”ง Configuration

Environment Variables

Create a .env file in the root directory:

REACT_APP_API_URL=your_api_url

Tailwind Configuration

The project uses a custom Tailwind configuration. Modify tailwind.config.js to update theme settings.

๐Ÿงช Running Tests

npm test

๐Ÿ“š Documentation

Component Usage

Dashboard Component

import { Dashboard } from './components/Dashboard';

// Basic usage
<Dashboard />

// With custom theme
<Dashboard isDarkMode={true} />

Authentication Forms

import { LoginForm, SignupForm } from './components/Auth';

// Login form
<LoginForm onLogin={handleLogin} />

// Signup form
<SignupForm onSignup={handleSignup} />

๐Ÿค Contributing

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

Coding Standards

  • Use functional components with hooks
  • Follow the existing file structure
  • Include proper TypeScript types (if converting to TypeScript)
  • Add comments for complex logic
  • Ensure responsive design
  • Test across different browsers

๐Ÿ“œ License

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

๐Ÿ™ Acknowledgments

  • Recharts for the charting library
  • Lucide React for the icon set
  • Tailwind CSS for the utility-first CSS framework

๐Ÿ› Known Issues

  • Chart responsiveness on very small screens
  • Dark mode flash on initial load
  • Performance optimization needed for large datasets

๐Ÿ”ฎ Future Improvements

  • Add TypeScript support
  • Implement real-time data updates
  • Add more chart types
  • Improve accessibility
  • Add end-to-end tests
  • Implement proper error boundaries
  • Add proper form validation
  • Implement proper state management (Redux/Context)
  • Add proper API integration
  • Implement proper routing

๐Ÿ“ž Support

For support, email dewanshshekharsingh@gmail.com or open an issue in the repository.

๐Ÿ”„ Version History

  • 0.1.0
    • Initial Release
    • Basic dashboard functionality
    • Authentication system
    • Dark mode support

About

Overview of the AI-Powered Personal Finance Assistant

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors