Skip to content

README.md

Latest commit

 

History

History
68 lines (48 loc) · 1.88 KB

README.md

File metadata and controls

68 lines (48 loc) · 1.88 KB

FileDoc Mini Admin

A Flutter-based admin panel for file management and analytics with Firebase integration.

App Design Preview

App Design Figma design mockup of the FileDoc Mini Admin interface

⚠️ Security Notice

IMPORTANT: This repository does not include Firebase configuration files for security reasons. You must set up your own Firebase project and configuration.

Required Setup Files (Not Included)

  • android/app/google-services.json
  • ios/Runner/GoogleService-Info.plist
  • lib/firebase_options.dart
  • .env file

Quick Start

  1. Read the setup guide: See SETUP.md for detailed instructions
  2. Configure Firebase: Set up your Firebase project and add configuration files
  3. Install dependencies: Run flutter pub get
  4. Run the app: flutter run

Features

  • 🔐 User Authentication (Firebase Auth)
  • 📊 Analytics Dashboard
  • 📁 File Management
  • 💰 Billing & Withdrawals
  • 📱 Multi-platform Support (Android, iOS, Web, Desktop)

Documentation

Project Structure

lib/
├── constant/          # App constants
├── controllers/       # GetX controllers
├── model/            # Data models
├── screens/          # UI screens
├── services/         # Business logic
├── widget/           # Reusable widgets
└── main.dart         # Entry point

Contributing

  1. Fork the repository
  2. Create your feature branch
  3. Follow the setup guide to configure Firebase
  4. Make your changes
  5. Submit a pull request

License

[Add your license here]

Note: This is a secure, production-ready codebase. All sensitive configuration files are excluded from version control for security purposes.