S3 Bucket File Uploader 🚀

A brick to get the s3 bucket file uploading service.

Generated by [mason][1] 🧱

Dependencies

This brick is dependent on the following dependencies. You have to add them in your pubspec.ymal under dependencies:

  mime: ^1.0.4
  sn_progress_dialog: ^1.1.3
  get_it: ^7.6.4

Setup

Add the following lines to your main.dart file.

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  // add this line
  registerGlobalServieces();
  runApp(const BaseWidget(Routes.SPLASH));
}

// add this method
void registerGlobalServieces() {
  GetIt.instance.registerSingleton<FileUploadRepository>(
    FileUploadRepository(
      imageUploadService: FileUploadService(
        backendUrlforS3Credentials: getS3SignedUrlsApiConstant,
        xAccessToken: Configuration().xAccessToken,
      ),
    ),
  );
}

Usage

  FileUploadRepository fileUploadRepository =
      GetIt.instance.get<FileUploadRepository>();

   final RepositoryResponse<String> s3ResponseUrls =
                await fileUploadRepository.getSignedUrlsFromBackend(
              filePath: *** your file path ***,
            );
            if (s3ResponseUrls.isSuccess){
            // s3 bucket uploaded file path
            print(s3ResponseUrls.data!);
            }

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add s3_uploader

# Install globally
mason add -g s3_uploader

Usage 🚀

mason make s3_uploader

Variables ✨

Hooks 🪝

• ❌   Pre-Gen
• ❌   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev.51 <0.1.0"

1.0.0+1

• S3 Bucket File Upload service added.

The MIT License (MIT) Copyright (c) 2022 Muhammad Talha

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.