iamrohitpal/roomie

Group-based expense splitter with NativePHP and FCM V1 notifications.

Maintainers

Package info

github.com/iamrohitpal/roomie

Language:Blade

Type:project

pkg:composer/iamrohitpal/roomie

Statistics

Installs: 0

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

1.0.0 2026-03-28 10:43 UTC

This package is auto-updated.

Last update: 2026-03-29 06:11:56 UTC


README

Roomie App Mockup

Roomie is a modern, group-centric expense tracking and splitting application built with Laravel 12 and NativePHP. Designed for roommates who want a stress-free way to manage shared costs, Roomie simplifies everything from daily groceries to monthly utility bills with real-time notifications and offline support.

๐ŸŒŸ Key Features

  • ๐Ÿ‘ฅ Group Collaboration: Scope expenses, roommates, and settlements to specific groups for better organization.
  • ๐Ÿ”” Real-Time Notifications: Integrated with Firebase Cloud Messaging (FCM) V1 for instant alerts on new expenses.
  • ๐Ÿ“ฑ Native Mobile Experience: Leverages NativePHP for a smooth, app-like feel on Android devices.
  • ๐Ÿ“ถ PWA & Offline Support: Service worker integration for reliable performance even without a connection.
  • ๐Ÿ’ธ Smart Expense Splitting: Split costs equally or by custom amounts with just a few taps.
  • โณ Settlement Tracking: Keep track of who owes what and mark debts as settled instantly.
  • ๐Ÿ‘ค Profile & Settings: Personalize your profile and manage notification permissions.
  • ๐Ÿงน Group Maintenance: Securely clear group data or export financial reports to CSV.

๐Ÿ› ๏ธ Tech Stack

๐Ÿš€ Quick Start

Prerequisites

  • PHP 8.2+
  • Composer
  • Node.js & NPM

Installation

  1. Clone the repository:

    git clone https://github.com/iamrohitpal/roomie.git
    cd roomie
  2. Install dependencies:

    composer install
    npm install
  3. Configure Environment: Copy .env.example to .env and configure your Firebase credentials:

    FIREBASE_API_KEY=your_key
    FIREBASE_PROJECT_ID=your_id
    FIREBASE_MESSAGING_SENDER_ID=your_sender_id
    FIREBASE_APP_ID=your_app_id
    FIREBASE_VAPID_KEY=your_vapid_key
  4. Firebase Service Account: Download your service account JSON from Firebase Console and save it as: storage/app/firebase-auth.json

  5. Run the setup:

    php artisan key:generate
    php artisan migrate
    npm run build
  6. Start the development server:

    composer run dev

๐Ÿ“ฆ Building for Android

To generate a release build for Android:

php artisan native:run android --build=release

๐Ÿ“œ License

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

Built with โค๏ธ for roommates everywhere.