💰 WealthLog

Smart Personal Finance Management for the Modern Era

Track • Analyze • Achieve
A comprehensive financial intelligence platform built with cutting-edge technology

Features • Quick Start • Tech Stack • Deploy • Contribute

---

🌟 Overview

WealthLog is a next-generation personal finance management platform that transforms how you interact with your money. Built with modern web technologies and designed with user experience at its core, WealthLog provides powerful insights into your financial health while maintaining simplicity and elegance.

"Financial freedom starts with financial awareness"

🎯 Why WealthLog?

• 🧠 Intelligent Analytics - AI-powered insights into your spending patterns
• ⚡ Real-time Updates - Instant dashboard refresh after every transaction
• 🎨 Modern UI/UX - Beautiful, responsive design with smooth animations
• 🔒 Bank-level Security - JWT authentication with bcrypt encryption
• 📱 Mobile-first - Optimized for all devices and screen sizes
• 🚀 Lightning Fast - Built with performance optimization in mind

---

✨ Features

📊 Smart Dashboard Real-time financial overview Interactive charts and visualizations Monthly/yearly trend analysis Spending pattern recognition 💳 Transaction Management Quick income/expense tracking Smart categorization system Bulk transaction operations Advanced filtering and search

🎯 Goal Tracking Set and monitor financial objectives Progress visualization Deadline reminders Achievement celebrations 📈 Analytics & Insights Spending behavior analysis Budget vs actual comparisons Category-wise breakdowns Export capabilities

🔥 Advanced Features

• 🤖 Smart Categorization - Automatic transaction categorization using ML
• 📊 Data Visualization - Beautiful charts powered by Recharts
• 🔄 Real-time Sync - Instant updates across all components
• 🎨 Theme Customization - Dark/light mode with custom themes
• 📱 PWA Ready - Install as a native app on any device
• 🔐 Privacy First - Your data stays secure and private

---

� ️ Tech Stack

Frontend Architecture

Backend Infrastructure

DevOps & Deployment

📋 Detailed Technology Breakdown

Frontend Excellence

• ⚛️ React 18 - Latest features with concurrent rendering
• ⚡ Vite - Lightning-fast build tool and dev server
• 🎨 Tailwind CSS - Utility-first CSS framework
• 🎭 Framer Motion - Production-ready motion library
• 📊 Recharts - Composable charting library
• 🧭 React Router - Declarative routing for React

Backend Power

• 🟢 Node.js 18+ - JavaScript runtime built on Chrome's V8
• 🚀 Express.js - Fast, unopinionated web framework
• 🍃 MongoDB - Document-based NoSQL database
• 🔐 JWT - Secure token-based authentication
• 🛡️ bcrypt - Industry-standard password hashing
• 📝 Winston - Professional logging library

Development & Deployment

• 🐳 Docker - Containerization for consistent environments
• ☁️ Vercel - Frontend deployment and hosting
• 🚄 Railway - Backend deployment and database hosting
• 🔄 GitHub Actions - CI/CD pipeline automation

---

🚀 Quick Start

Prerequisites

Required Node.js 18+ npm or yarn MongoDB (local or cloud)

Recommended Git VS Code MongoDB Compass

⚡ One-Click Setup

# Clone the repository
git clone https://github.com/Rammiso/WealthLog.git
cd WealthLog

# Install dependencies for both frontend and backend
npm run install:all

# Set up environment variables
npm run setup:env

# Start development servers
npm run dev

🔧 Manual Setup

Step-by-step installation

1. Backend Setup

cd backend
npm install

# Copy and configure environment variables
cp .env.example .env
# Edit .env with your MongoDB URI and JWT secret

# Start the backend server
npm start

2. Frontend Setup

cd frontend
npm install

# Copy and configure environment variables
cp .env.example .env
# Edit .env with your backend API URL

# Start the development server
npm run dev

3. Database Setup

# Create sample data (optional)
cd backend
node scripts/create-sample-data.js

🐳 Docker Setup

# One command to rule them all
docker-compose up -d

# Access your application
# Frontend: http://localhost
# Backend: http://localhost:3000
# MongoDB: localhost:27017

---

📁 Project Architecture

WealthLog/
├── 🎨 frontend/                 # React application
│   ├── src/
│   │   ├── Components/         # Reusable UI components
│   │   ├── Pages/             # Route-based page components
│   │   ├── Context/           # React context providers
│   │   ├── hooks/             # Custom React hooks
│   │   ├── services/          # API service layer
│   │   └── utils/             # Utility functions
│   ├── public/                # Static assets
│   └── dist/                  # Production build
├── 🔧 backend/                  # Node.js API server
│   ├── src/
│   │   ├── app/               # Express app configuration
│   │   ├── usecases/          # Business logic layer
│   │   ├── infrastructure/    # Database & external services
│   │   ├── utils/             # Utility functions
│   │   └── config/            # Configuration files
│   └── scripts/               # Database scripts & tools
├── 🐳 docker-compose.yml       # Container orchestration
├── 📚 DEPLOYMENT.md            # Deployment guide
└── 📖 README.md               # You are here

---

🚀 Deployment

🌟 Recommended: Railway + Vercel

Backend on Railway npm install -g @railway/cli railway login cd backend railway up

Frontend on Vercel npm install -g vercel cd frontend vercel --prod

🐳 Docker Deployment

# Production deployment
docker-compose -f docker-compose.prod.yml up -d

# Development with hot reload
docker-compose up -d

☁️ Cloud Platforms

Platform	Backend	Frontend	Database
Railway	✅ Recommended	❌	✅ MongoDB
Vercel	❌	✅ Recommended	❌
Heroku	✅ Good	✅ Good	✅ MongoDB Atlas
DigitalOcean	✅ VPS	✅ Static	✅ Managed DB

📖 Detailed deployment instructions: See DEPLOYMENT.md

---

🔧 Configuration

Environment Variables

Backend Configuration

# Server Configuration
NODE_ENV=production
PORT=3000

# Database
MONGODB_URI=mongodb://localhost:27017/wealthlog

# Authentication
JWT_SECRET=your-super-secret-jwt-key-minimum-32-characters
JWT_EXPIRES_IN=7d
BCRYPT_ROUNDS=12

# Optional: Email Service
SMTP_HOST=smtp.gmail.com
SMTP_PORT=587
SMTP_USER=[email protected]
SMTP_PASS=your-app-password

Frontend Configuration

# API Configuration
VITE_API_URL=http://localhost:3000/api/v1

# Optional: Analytics
VITE_GA_TRACKING_ID=G-XXXXXXXXXX
VITE_SENTRY_DSN=https://your-sentry-dsn

# Feature Flags
VITE_ENABLE_PWA=true
VITE_ENABLE_ANALYTICS=false

---

🤝 Contributing

We love contributions! Here's how you can help make WealthLog even better:

🌟 Ways to Contribute

• 🐛 Bug Reports - Found a bug? Let us know!
• 💡 Feature Requests - Have an idea? We'd love to hear it!
• 📝 Documentation - Help improve our docs
• 🔧 Code Contributions - Submit a pull request

🚀 Development Workflow

# 1. Fork the repository
# 2. Create a feature branch
git checkout -b feature/amazing-feature

# 3. Make your changes
# 4. Test your changes
npm run test

# 5. Commit with conventional commits
git commit -m "feat: add amazing feature"

# 6. Push and create a pull request
git push origin feature/amazing-feature

📋 Development Guidelines

• Follow the existing code style
• Write meaningful commit messages
• Add tests for new features
• Update documentation as needed
• Ensure all tests pass

---

📊 Roadmap

🎯 Current Sprint (v1.1)

• Mobile App - React Native implementation
• AI Insights - Machine learning spending predictions
• Bank Integration - Connect with banking APIs
• Multi-currency - Support for multiple currencies

🚀 Future Releases

• Investment Tracking - Portfolio management
• Bill Reminders - Automated payment notifications
• Family Sharing - Multi-user account management
• Advanced Analytics - Custom reporting dashboard

---

📄 License

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

MIT License - feel free to use this project for personal or commercial purposes

---

🙏 Acknowledgments

Built with ❤️ by passionate developers

Special thanks to the amazing open-source community and these fantastic projects:

🌟 Credits

• Icons - Lucide React
• Charts - Recharts
• Animations - Framer Motion
• Styling - Tailwind CSS

---

💬 Get in Touch

🐛 Report Bug • 💡 Request Feature • 📧 Contact

⭐ Star this repository if you found it helpful!

---

Made with 💰 for better financial management