Skip to content

A modern web application designed to simplify expense sharing and management among flatmates. This tool helps you track shared expenses, manage grocery lists, and settle balances with your roommates effortlessly.

License

Notifications You must be signed in to change notification settings

Razee4315/Flatmate_Expense_Manager

Repository files navigation

🏠 Flatmate Expense Manager

A modern web application designed to simplify expense sharing and management among flatmates. This tool helps you track shared expenses, manage grocery lists, and settle balances with your roommates effortlessly.

✨ Features

  • 👥 User Authentication: Secure signup and login system
  • 💰 Expense Tracking: Add and manage shared expenses
  • 📊 Dashboard: Visual overview of expenses and balances
  • 🛒 Grocery List: Collaborative shopping list management
  • 💸 Balance Settlement: Easy calculation of who owes whom
  • 🏠 Flat Management: Add and manage flatmates

🚀 Getting Started

Prerequisites

  • Python 3.8 or higher
  • pip (Python package manager)
  • Git

Installation

  1. Clone the repository
git clone https://github.com/Razee4315/Flatmate-Expense-Manager.git
cd Flatmate-Expense-Manager
  1. Create a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
  1. Install dependencies
pip install -r requirements.txt
  1. Set up the database
flask db upgrade
  1. Run the application
python run.py

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

🛠️ Tech Stack

  • Backend: Flask (Python)
  • Database: SQLite
  • Frontend: HTML, CSS, JavaScript
  • Authentication: Flask-Login
  • Forms: Flask-WTF
  • Database ORM: SQLAlchemy

📱 Usage

  1. Sign Up/Login: Create an account or login to existing one
  2. Create/Join Flat: Set up your flat and invite flatmates
  3. Add Expenses: Record shared expenses with details
  4. Track Groceries: Maintain shared shopping lists
  5. Settle Up: View balances and settle payments

🤝 Contributing

Contributions are welcome! Here's how you can help:

  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

📝 License

This project is open source and available under the MIT License.

🙏 Acknowledgments

  • Thanks to all contributors who help improve this project
  • Inspired by the need for better flatmate expense management
  • Built with ❤️ using Flask and modern web technologies

📞 Contact

Latest Updates

  • Added expense editing and deletion functionality
  • Improved dashboard with real-time expense tracking
  • Enhanced user interface for better expense management
  • Added comprehensive expense splitting features

About

A modern web application designed to simplify expense sharing and management among flatmates. This tool helps you track shared expenses, manage grocery lists, and settle balances with your roommates effortlessly.

Resources

License

Stars

Watchers

Forks

Packages