Skip to content

README.md

Latest commit

 

History

History
127 lines (95 loc) · 3.33 KB

README.md

File metadata and controls

127 lines (95 loc) · 3.33 KB

FileDock User

A Flutter-based file management and video sharing application that allows users to upload, manage, and share files with an intuitive user interface.

App Design

Features

  • 📁 File Management: Upload, organize, and manage your files
  • 🎥 Video Player: Built-in video player with controls
  • 📱 Cross-Platform: Runs on Android, iOS, and other Flutter-supported platforms
  • 🔗 File Sharing: Share files with others easily
  • 📊 Analytics: Track file usage and downloads
  • 🎯 Ad Integration: Google Mobile Ads integration
  • 🔥 Firebase Backend: Cloud storage and real-time database

Tech Stack

  • Framework: Flutter 3.8.1+
  • State Management: GetX
  • Backend: Firebase (Firestore, Storage, Remote Config)
  • UI: Custom responsive design with ScreenUtil
  • Video: Video Player with thumbnail generation
  • Ads: Google Mobile Ads
  • Storage: Local storage with path provider

Getting Started

Prerequisites

  • Flutter SDK (3.8.1 or higher)
  • Dart SDK
  • Android Studio / VS Code
  • Firebase project setup

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/filedock_user.git
cd filedock_user
  1. Install dependencies:
flutter pub get

  1. Set up Firebase:

    • Create a new Firebase project
    • Add your google-services.json to android/app/
    • Add your GoogleService-Info.plist to ios/Runner/
    • Update lib/firebase_options.dart with your configuration

  2. Run the app:

flutter run

Project Structure

lib/
├── admanager/          # Ad management logic
├── adwidgets/          # Ad display widgets
├── constant/           # App constants and colors
├── controllers/        # GetX controllers
├── model/             # Data models
├── screens/           # UI screens
├── widget/            # Reusable widgets
├── firebase_options.dart
└── main.dart

Key Dependencies

  • flutter_screenutil: Responsive UI design
  • get: State management and navigation
  • firebase_core: Firebase integration
  • cloud_firestore: Database
  • firebase_storage: File storage
  • video_player: Video playback
  • google_mobile_ads: Advertisement integration
  • share_plus: File sharing functionality

Configuration

Before running the app, make sure to:

  1. Set up your Firebase project
  2. Configure your package name in android/app/build.gradle
  3. Update app icons using flutter_launcher_icons
  4. Configure permissions in android/app/src/main/AndroidManifest.xml

Building for Release

Android

flutter build apk --release
# or
flutter build appbundle --release

iOS

flutter build ios --release

Contributing

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

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

For support, email support@filedock.com or create an issue in this repository.

Note: This app requires proper Firebase configuration. Make sure to set up your own Firebase project and update the configuration files accordingly.