Skip to content

MavCodeAI/HP4

Repository files navigation

πŸš€ HisaabPlus - Professional Business Management App

Complete Accounting & Business Management Solution for Pakistani Businesses

Version 4.0 | December 2024


πŸ“± Overview

HisaabPlus is a comprehensive Flutter-based business management application specifically designed for Pakistani businesses. It provides complete invoice management, inventory control, customer relationship management, and financial reporting with specialized PKR currency formatting.


✨ Features

πŸ” Security & Authentication

  • βœ… Secure user authentication with SHA-256 password hashing
  • βœ… Encrypted local storage using flutter_secure_storage
  • βœ… Role-based access control (Owner, Manager, Accountant, Staff, Viewer)
  • βœ… Session management and auto-logout

🧾 Invoice Management

  • βœ… Professional invoice creation and editing
  • βœ… Multiple invoice templates
  • βœ… PDF generation with company branding
  • βœ… WhatsApp and email sharing
  • βœ… Payment tracking (Pending, Paid, Overdue)
  • βœ… Automatic invoice numbering

πŸ‘₯ Customer & Vendor Management

  • βœ… Complete customer database
  • βœ… Vendor/supplier management
  • βœ… Contact information storage
  • βœ… Purchase history tracking
  • βœ… Outstanding balance monitoring

πŸ“¦ Inventory Management

  • βœ… Product catalog with categories
  • βœ… Stock level tracking
  • βœ… Low stock alerts
  • βœ… Barcode support
  • βœ… Purchase and selling price management
  • βœ… Stock movement history

πŸ’° Financial Management

  • βœ… Specialized PKR currency formatting (Ω„Ψ§Ϊ©ΪΎΨŒ Ϊ©Ψ±ΩˆΪ‘)
  • βœ… Credit/Debit account management
  • βœ… Expense tracking and categorization
  • βœ… Payment reminders
  • βœ… Cash flow analysis

πŸ“Š Reports & Analytics

  • βœ… Comprehensive business dashboard
  • βœ… Sales and expense reports
  • βœ… Profit & Loss statements
  • βœ… Inventory reports
  • βœ… Visual charts and graphs
  • βœ… Export to PDF and Excel

☁️ Cloud Features

  • βœ… Firebase real-time synchronization
  • βœ… Multi-device access
  • βœ… Automatic backup
  • βœ… Offline mode with sync
  • βœ… Data conflict resolution

🎨 User Experience

  • βœ… Material Design 3 interface
  • βœ… Dark/Light theme support
  • βœ… Responsive design for tablets
  • βœ… Intuitive navigation
  • βœ… Professional animations

πŸ› οΈ Technical Stack

Technology Version Purpose
Flutter 3.16+ Cross-platform mobile framework
Dart 3.0+ Programming language
SQLite Latest Local database storage
Firebase Latest Cloud sync and authentication
Provider 6.1.2 State management
Material Design 3 Latest UI/UX framework

πŸ“‹ Requirements

Development Environment

  • Flutter SDK 3.16.0 or higher
  • Dart SDK 3.0.0 or higher
  • Android Studio or VS Code
  • Git for version control

Device Requirements

  • Android: API level 21+ (Android 5.0+)
  • iOS: iOS 12.0+ (coming soon)
  • Storage: Minimum 100MB free space
  • RAM: 2GB+ recommended

πŸš€ Installation & Setup

1. Clone Repository

git clone https://github.com/yourusername/hisabplusz1.git
cd hisabplusz1

2. Install Dependencies

flutter pub get

3. Environment Configuration

Create .env file in project root:

GOOGLE_API_KEY=your_google_api_key_here
FIREBASE_PROJECT_ID=your_firebase_project_id

4. Firebase Setup

  1. Create Firebase project at console.firebase.google.com
  2. Add Android app to Firebase project
  3. Download google-services.json and place in android/app/
  4. Enable Firestore Database and Authentication

5. Run Application

flutter run

πŸ§ͺ Testing

Run Unit Tests

flutter test

Run Widget Tests

flutter test test/widgets/

Run Integration Tests

flutter test integration_test/

Generate Coverage Report

flutter test --coverage
genhtml coverage/lcov.info -o coverage/html

πŸ“ Project Structure

hisabplusz1/
β”œβ”€β”€ android/                 # Android platform files
β”œβ”€β”€ assets/                  # App assets (icons, images)
β”‚   β”œβ”€β”€ icons/              # App icons
β”‚   β”œβ”€β”€ images/             # Images and graphics
β”‚   └── logos/              # Brand logos
β”œβ”€β”€ docs/                   # Documentation
β”‚   β”œβ”€β”€ USER_MANUAL.md      # User guide
β”‚   └── API_DOCUMENTATION.md # Technical docs
β”œβ”€β”€ integration_test/       # Integration tests
β”œβ”€β”€ ios/                    # iOS platform files
β”œβ”€β”€ lib/                    # Main application code
β”‚   β”œβ”€β”€ config/            # Configuration files
β”‚   β”œβ”€β”€ models/            # Data models
β”‚   β”œβ”€β”€ providers/         # State management
β”‚   β”œβ”€β”€ screens/           # UI screens
β”‚   β”œβ”€β”€ services/          # Business logic
β”‚   β”œβ”€β”€ utils/             # Utilities and helpers
β”‚   └── web_dashboard/     # Web interface
β”œβ”€β”€ test/                   # Unit and widget tests
└── web/                    # Web platform files

πŸ”§ Configuration

Database Schema

The app uses SQLite for local storage with the following main tables:

  • parties - Customer and vendor information
  • products - Inventory items
  • invoices - Invoice headers
  • invoice_items - Invoice line items
  • expenses - Business expenses

Security Configuration

  • All sensitive data encrypted with flutter_secure_storage
  • Passwords hashed using SHA-256
  • API keys stored in environment variables
  • Role-based access control implemented

πŸ“š Documentation

For Users

For Developers


🌟 Key Highlights

Pakistani Business Focus

  • PKR Currency: Specialized formatting with Ω„Ψ§Ϊ©ΪΎ and Ϊ©Ψ±ΩˆΪ‘ support
  • Local Numbers: Pakistani phone number validation
  • Business Practices: Designed for local business workflows
  • Urdu Support: Ready for Urdu language integration

Professional Features

  • Multi-User System: Role-based access for teams
  • Cloud Sync: Real-time data synchronization
  • Offline Mode: Work without internet connection
  • Advanced Analytics: Business intelligence and insights
  • PDF Generation: Professional invoice and report PDFs

Enterprise Ready

  • Scalable Architecture: Handles growing business needs
  • Security First: Enterprise-grade data protection
  • Audit Trail: Complete change tracking
  • Backup & Restore: Data protection and recovery

πŸš€ Deployment

Google Play Store

  1. Generate Release APK:

    flutter build apk --release
  2. Generate App Bundle:

    flutter build appbundle --release
  3. Configure Signing: Update android/app/build.gradle with signing config

  4. Upload to Play Console: Submit to Google Play Store

Web Deployment

flutter build web --release

🀝 Contributing

Development Guidelines

  1. Code Style: Follow Flutter/Dart conventions
  2. Testing: Write tests for new features
  3. Documentation: Update docs for changes
  4. Security: Never commit sensitive data

Pull Request Process

  1. Fork the repository
  2. Create feature branch: git checkout -b feature/amazing-feature
  3. Commit changes: git commit -m 'Add amazing feature'
  4. Push to branch: git push origin feature/amazing-feature
  5. Open Pull Request

πŸ› Troubleshooting

Common Issues

Build Errors:

  • Run flutter clean && flutter pub get
  • Check Flutter/Dart SDK versions
  • Verify environment configuration

Firebase Issues:

  • Verify google-services.json placement
  • Check Firebase project configuration
  • Ensure Firestore rules are set

Sync Problems:

  • Check internet connection
  • Verify Firebase authentication
  • Use "Force Sync" in settings

πŸ“ž Support

Getting Help

  • Email: support@hisaabplus.com
  • Documentation: Check docs/ folder
  • Issues: Create GitHub issue for bugs
  • Discord: Join our developer community

Business Inquiries


πŸ“œ License

MIT License

Copyright (c) 2024 HisaabPlus Development Team

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILTY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

πŸ† Acknowledgments

  • Flutter Team - Amazing cross-platform framework
  • Firebase Team - Excellent cloud services
  • Pakistani Developer Community - Inspiration and feedback
  • Local Businesses - Real-world testing and requirements

πŸ”— Links


Made with ❀️ for Pakistani Businesses

Β© 2024 HisaabPlus Development Team. All rights reserved.

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published