Financely ✨

A smart, collaborative expense tracker for families and groups, powered by AI.

---

📌 About The Project

Financely is a modern, full-stack web app that brings clarity and simplicity to group financial management. Whether you’re managing shared household expenses or budgeting with roommates, Financely offers a secure, intuitive, and AI-powered platform to track, analyze, and manage spending collaboratively.

“Where did the money go?” Financely helps you answer that—clearly and smartly.

🔐 Secure

Built on Firebase with strict authentication and security rules to ensure isolated, private data for each group.

🤝 Collaborative

Real-time syncing allows all group members to stay up-to-date instantly.

🧠 Intelligent

Powered by Google Gemini API for smart insights, auto-categorization, and spending analysis.

📱 Accessible

Mobile-first responsive design works seamlessly across all screen sizes.

---

🚀 Features

• Multi-Group Management: Join or create multiple groups with their own members and budgets.
• Shared & Personal Wallets: Separate shared group expenses from individual spending.
• Role-Based Access Control: Assign roles like ADMINISTRATOR or MANAGER to members.
• AI-Powered Insights: Smart spending analysis and auto-categorization using Gemini API.
• Secure Authentication: Sign up/login via Email or Google.
• Real-Time Updates: Instant data sync using Firestore.
• Responsive UI: Optimized for mobile and desktop devices.

---

🛠️ Tech Stack

• Framework: Next.js
• Backend & Database: Firebase (Firestore, Auth, Messaging)
• Styling: Tailwind CSS
• UI Components: shadcn/ui
• AI Integration: Google Gemini API
• Deployment: Vercel

---

📁 Project Structure

/
├── app/                # Next.js App Router
│   ├── (auth)/         # Login and signup pages
│   ├── (main)/         # Authenticated dashboard pages
│   │   ├── dashboard/
│   │   └── layout.tsx
│   └── layout.tsx      # Root layout
├── components/         # Reusable React components
│   ├── auth/           # Authentication UI
│   ├── dashboard/      # Dashboard-specific UI
│   └── ui/             # Generic UI (shadcn/ui)
├── lib/                # Utils and Firebase setup
│   ├── firebase.ts
│   └── hooks.ts
├── public/             # Static files
└── styles/             # Global styles

---

🧑‍💻 Getting Started

✅ Prerequisites

• Node.js v18+
• npm or yarn

📦 Installation

# Clone the repository
git clone https://github.com/your_username/financely.git
cd financely

# Install dependencies
npm install

🔐 Environment Variables

Create a .env.local file in the root directory and add your credentials:

# Firebase Configuration
NEXT_PUBLIC_FIREBASE_API_KEY=your_api_key
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your_auth_domain
NEXT_PUBLIC_FIREBASE_PROJECT_ID=your_project_id
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your_storage_bucket
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
NEXT_PUBLIC_FIREBASE_APP_ID=your_app_id

# Gemini API Key
NEXT_PUBLIC_GEMINI_API_KEY=your_gemini_api_key

Set up your Firebase project at Firebase Console Get Gemini API access via Google AI Studio

🏃 Run Locally

npm run dev

Open http://localhost:3000 to view it in your browser.

---

🧭 Roadmap

We have many ideas for the future of Financely! Here are some features we're planning:

• Budgeting Tools: Set monthly budgets for specific categories and receive alerts.
• Advanced Reports: Generate and export monthly or yearly financial reports as PDFs.
• Push Notifications: Get real-time notifications when a member adds a transaction.
• Recurring Transactions: Set up automatic logging for recurring bills like rent or subscriptions.

---

📄 License

Distributed under the MIT License. See LICENSE.txt for more information.

---

🤝 Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.

---

🌐 Live Demo

Coming soon on Vercel

---

📷 Screenshot

Replace the placeholder image above with a screenshot of your app in action.

---

🙌 Support

If you find this project useful, please consider giving it a ⭐️ on GitHub!