Skip to content

NemesisX1/moneroo_flutter_sdk

Repository files navigation

Moneroo Flutter SDK

style: very good analysis Powered by Mason License: MIT

A Very Good Project created by Very Good CLI.

Installation 💻

❗ In order to start using Moneroo Flutter you must have the Flutter SDK installed on your machine.

Install via flutter pub add:

flutter pub add moneroo_flutter_sdk

About ❓

This package allows you to use Moneroo to process payment within your Flutter app.

Configuration 🔧

Android

Add this line in your AndroidManifest.xml. This will help you to avoid an ERR_CLEAR_TEXT_NOT_PERMITTED error while processing a payment.

Don't forget to allow internet access in your Android app ! Info here !

<application
        ...
        android:usesCleartextTraffic="true"
        ...
        >
        ...
</application>

IOS

Add this line in your Info.plist. This will help you to avoid an ERR_CLEAR_TEXT_NOT_PERMITTED error while processing a payment.

<plist>
...
    <key>NSAppTransportSecurity</key>
    <dict>
        <key>NSAllowsArbitraryLoads</key>
         <true/>
     </dict>
...
<plist>

Usage 🚀

You can a have a full example here. You can also your the MonerooApi class to implement the payment yourself without using the Moneroo widget provided by this package.

Exception Handling 🐛

  • MonerooException: This exception is throw when an error occured in during the API calling. You can have more infos about the related error logging the class's attribute.
  • ServiceUnavailableException: This exception is throw when the SDK was'nt able to send your request to the server. Maybe due to network issues.

Continuous Integration 🤖

Moneroo Flutter comes with a built-in GitHub Actions workflow powered by Very Good Workflows but you can also add your preferred CI/CD solution.

Out of the box, on each pull request and push, the CI formats, lints, and tests the code. This ensures the code remains consistent and behaves correctly as you add functionality or make changes. The project uses Very Good Analysis for a strict set of analysis options used by our team. Code coverage is enforced using the Very Good Workflows.


Running Tests 🧪

For first time users, install the very_good_cli:

dart pub global activate very_good_cli

To run all unit tests:

very_good test --coverage

Don't forget to fill your credentials in the test file.

To view the generated coverage report you can use lcov.

# Generate Coverage Report
genhtml coverage/lcov.info -o coverage/

# Open Coverage Report
open coverage/index.html