Flutter Sharez 🚀

**

Flutter Sharez is a modern file-sharing app built using the Flutter framework and powered by Riverpod. This app allows users to effortlessly share and receive files across different platforms. With an intuitive and user-friendly interface, Flutter Sharez redefines the way you share files.

Features 🌟

• 🔄 Cross-Platform: Flutter Sharez is developed using Flutter, ensuring seamless performance and a consistent user experience across multiple platforms, including iOS, Android, Linux, MacOS, and Windows.

• 📁 File Sharing: Share files of various formats, such as images, documents, videos, and more, with just a few taps. Receive files from others as well.

• 🖼️ User-Friendly Interface: The app features a clean and intuitive interface that makes sharing and receiving files a breeze, even for first-time users.

• 🎨 Theme Options: Flutter Sharez offers a customizable theme experience. Choose between light, dark, or let the app automatically switch based on system preferences.

• 🚀 Riverpod Powered: Flutter Sharez utilizes the Riverpod state management library, enabling efficient and scalable state management throughout the app.

• 🔄 Resumable Downloads: Introduce the ability to resume interrupted or paused downloads, ensuring a seamless download experience even in case of network disruptions.

• 🌐 Localization Support: Elevate the experience with multi-language support and localization.

• ⚙️ Settings: Access the app's settings to customize your experience, including options to check for updates and navigate to download pages for downloading updates.

• 🐛 Bug/Feature Report: Easily report bugs or suggest new features to help us continually improve Flutter Sharez.

Screenshots 📸

Sender Screen

Receiver Screen

Installation 🛠️

To get started with Flutter Sharez, follow these steps:

1. Clone the repository:

   git clone https://github.com/Shreemanarjun/flutter_sharez.git

2. Navigate to the project directory:

   cd flutter_sharez

3. Install dependencies:

   flutter pub get

4. Run the app:

   flutter run

For more detailed instructions, troubleshooting, and additional setup options,

Packages Used 📦

• ai_barcode_scanner: A barcode scanning package that uses AI to recognize barcodes in images or camera streams.

• alfred: A Dart package for server-side management, simplifying tasks such as handling requests, routing, and resource management.

• auto_route: A powerful routing package that generates named routes and simplifies navigation in your Flutter app.

• dart_jwt_token: A package for working with JSON Web Tokens (JWT) for secure authentication and authorization.

• dio: A versatile HTTP client for making network requests, handling responses, and working with interceptors.

• dio_smart_retry: An extension for Dio that provides smart retry mechanisms for failed HTTP requests.

• file_picker: A package for picking files from various sources, including the device's storage and cloud services.

• flutter_riverpod: A state management library based on Provider, enabling reactive and efficient app state management.

• hive_flutter: A lightweight and fast NoSQL database for Flutter, providing local storage capabilities.

• lottie: A Flutter package for displaying Lottie animations, adding dynamic and interactive animations to your app.

• qr_flutter: A package for generating QR codes as widgets in your Flutter app.

For a complete list of dependencies, including minor packages, please refer to the pubspec.yaml file.

To-Do Features 📝

Here's what's on the horizon for Flutter Sharez:

• 📂 Already Downloaded File List: Display a list of files already downloaded for easy tracking.

• 📡 Manual Connections: Empower users to connect with other devices manually, taking charge of the sharing process.

• 📷 QR Scan: Introduce QR code scanning to swiftly and securely share files.

• ✨ Code Push Support: Implement code push functionality using Shorebird for seamless and efficient app updates without requiring users to download a new version.

Stay tuned as we work on these exciting enhancements!

These are just a few of the exciting features we have in mind. Stay tuned for updates as we continue to enhance Flutter Sharez!

Contributing 🤝

Contributions are welcome! If you encounter any issues or have ideas for enhancements, feel free to create issues or pull requests in this repository.

Getting Started

• Fork the repository.
• Clone the forked repository to your local machine.
• Create a new branch for your changes.
• Make your modifications or additions.
• Commit your changes with descriptive messages.
• Push your changes to your forked repository.
• Create a pull request to the original repository's main branch.

Guidelines

• Follow the project's coding style and conventions.
• Provide detailed descriptions in your pull requests and issues.
• Be respectful and considerate in discussions.

Your contributions help improve and grow the project!

License 🍀

This project is licensed under the MIT License.

MIT License

Copyright (c) 2023 Shreeman Arjun Sahu

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 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---

Diagram 🍀

%%{init: { 'theme': 'forest' } }%%

flowchart TB
    %% External / User
    U["User"]:::external

    %% Presentation Layer
    subgraph "Presentation Layer"
        FUI["Features (UI)"]:::presentation
    end

    %% Business Logic Layer
    subgraph "Business Logic Layer"
        FCP["Feature Controllers & Providers"]:::business
    end

    %% Data Layer
    subgraph "Data Layer"
        DM["Data Models"]:::data
        SS["Sender Service"]:::data
        RS["Receiver Service"]:::data
        AC["API Client"]:::data
        LS["Local Storage"]:::data
    end

    %% Core Utilities
    subgraph "Core Utilities"
        NAV["Navigation (AutoRoute)"]:::core
        TH["Theme"]:::core
        LOC["Localization"]:::core
    end

    %% Platform Configurations
    subgraph "Platform Configurations"
        ANDR["Android"]:::platform
        IOS["iOS"]:::platform
        MAC["macOS"]:::platform
        WEB["Web"]:::platform
    end

    %% Connections
    U -->|"interacts"| FUI
    FUI -->|"triggers"| FCP
    FCP -->|"processes"| DM
    FCP -->|"calls"| SS
    FCP -->|"calls"| RS
    SS -->|"uses"| AC
    RS -->|"uses"| AC
    AC -->|"returns"| FCP
    FCP -->|"updates"| FUI
    FUI -->|"navigates"| NAV
    FUI -->|"styledBy"| TH
    FUI -->|"localizedBy"| LOC
    FCP -->|"accesses"| LS

    %% Core Utilities to Platform
    NAV -->|"platformSpecific"| ANDR
    NAV -->|"platformSpecific"| IOS
    NAV -->|"platformSpecific"| MAC
    NAV -->|"platformSpecific"| WEB

    %% Styles
    classDef external fill:#FFFFE0,stroke:#000,stroke-width:2px;
    classDef presentation fill:#ADD8E6,stroke:#000,stroke-width:2px;
    classDef business fill:#90EE90,stroke:#000,stroke-width:2px;
    classDef data fill:#FFA07A,stroke:#000,stroke-width:2px;
    classDef core fill:#E6E6FA,stroke:#000,stroke-width:2px;
    classDef platform fill:#D3D3D3,stroke:#000,stroke-width:2px;

    %% Click Events
    click FUI "https://github.com/shreemanarjun/flutter_sharez/tree/main/lib/features"
    click NAV "https://github.com/shreemanarjun/flutter_sharez/tree/main/lib/core/router"
    click TH "https://github.com/shreemanarjun/flutter_sharez/tree/main/lib/core/theme"
    click LOC "https://github.com/shreemanarjun/flutter_sharez/tree/main/lib/l10n"
    click FCP "https://github.com/shreemanarjun/flutter_sharez/tree/main/lib/features/counter/controller"
    click DM "https://github.com/shreemanarjun/flutter_sharez/tree/main/lib/data/model"
    click SS "https://github.com/shreemanarjun/flutter_sharez/tree/main/lib/data/service/sender"
    click RS "https://github.com/shreemanarjun/flutter_sharez/tree/main/lib/data/service/receiver"
    click AC "https://github.com/shreemanarjun/flutter_sharez/tree/main/lib/shared/api_client"
    click LS "https://github.com/shreemanarjun/flutter_sharez/tree/main/lib/core/local_storage"
    click ANDR "https://github.com/shreemanarjun/flutter_sharez/tree/main/android"
    click IOS "https://github.com/shreemanarjun/flutter_sharez/tree/main/ios"
    click MAC "https://github.com/shreemanarjun/flutter_sharez/tree/main/macos"
    click WEB "https://github.com/shreemanarjun/flutter_sharez/tree/main/web"

Loading