Skip to content

Repository files navigation

💰 ChamaSmart

ChamaSmart is a Flutter-based mobile application designed to simplify the management of Chamas (informal savings and investment groups). It helps streamline contributions, loans, fines, and financial records, all from a mobile device — with support for M-Pesa and AI-powered assistance.


🚀 Features

  • 🔐 Firebase Authentication (Email/Password)

    • ⚠️Note:Verification code logic is not yet connected to Firestore. You can enter any code to proceed during registration for now.
  • 💳 M-Pesa Integration via Daraja API (STK Push for contributions/payments)

    • ⚠️ Currently under development.STK push functionality may not work as expected at this stage.
  • 📈 Track contributions, withdrawals, deposits, profits, and fines

  • 🧾 Member management and meeting scheduling

  • 💬 Real-time chat (Firebase)

  • 🧠 Built-in AI Assistant for user support (OpenAI integration)

    • ⚠️API not yet activated.Assistant is visible but will not respond to prompts until OpenAI billing is set up.
  • 📱 Clean, intuitive Flutter UI


Note

🛠️ Setup Instructions

1.Clone the repository:

git clone https://github.com/your-username/chamasmart.git
cd chamasmart

2.Install dependencies:

flutter pub get
  1. Add Firebase configuration:
    • Generate firebase_options.dart using flutterfire configure
    • Or place your Firebase config manually under lib/firebase_options.dart
  2. Run the app:
    flutter run

Note

🧪 Testing

  • ✅ Unit tests: form validation, authentication logic
  • ✅ Widget tests: login and registration flows
  • 🚧 Integration tests (in progress)

Run all tests:

flutter test

👨🏾‍💻 Development Workflow

  • 🔁 Agile development with weekly standups
  • 🗂️ Task tracking with GitHub Projects / Issues
  • ✅ Code reviews and pair programming
  • 🌱 Branch naming: feature/, fix/, test/

👥 Team

  • Michelle Wanjiru Kang'ethe – Lead Developer, M-Pesa API Integration, Flutter UI

📂 Folder Structure

lib/
├── screens/         # All UI screens
├── models/          # Data models
├── services/        # Firebase, M-Pesa API services
├── widgets/         # Reusable UI components
├── firebase_options.dart

📄 License

This project is licensed under the MIT License.


📬 Contact

For support or inquiries, reach out to:
📧 [michellekangethe@gmail.com]
📱 +254 717 895 133


✅ Optional Additions

  • Screenshots of the app
  • Environment variable instructions for M-Pesa keys
  • GitHub Actions or CI/CD badge

⚠️ Disclaimer

This app is currently under active development. All data displayed or entered is for demo and testing purposes only and should not be considered real or secure. Please do not input sensitive or personal information at this time.

About

ChamaSmart is a Flutter-based mobile application designed to simplify the management of Chamas (informal savings and investment groups). It helps streamline contributions, loans, fines, and financial records, all from a mobile device — with support for M-Pesa and AI-powered assistance.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages