Git Product home page Git Product logo

omofolarin / amplify-flutter Goto Github PK

View Code? Open in Web Editor NEW

This project forked from aws-amplify/amplify-flutter

0.0 0.0 0.0 52.49 MB

A declarative library with an easy-to-use interface for building Flutter applications on AWS.

Home Page: https://docs.amplify.aws

License: Apache License 2.0

Shell 0.89% JavaScript 0.05% Ruby 0.15% C++ 0.33% C 0.04% Objective-C 0.24% Java 0.23% Kotlin 4.65% Dart 89.19% TypeScript 1.16% CSS 0.03% Swift 2.17% Makefile 0.03% HTML 0.29% CMake 0.30% Dockerfile 0.02% Smithy 0.23%

amplify-flutter's Introduction

AWS Amplify

discord

Amplify Flutter

AWS Amplify provides a declarative and easy-to-use interface across different categories of cloud operations. Our default implementation works with Amazon Web Services (AWS), but AWS Amplify is designed to be open and pluggable for any custom backend or service. See AWS Amplify for further details about the Amplify Framework.

We are iterating and looking for feedback and collaboration, so please let us know your feedback on our direction and roadmap.

Supported Amplify Libraries

Library pub.dev package Description
Authentication APIs and building blocks for developers who want to create user authentication experiences with Amazon Cognito.
Analytics Easily collect analytics data for your app with Pinpoint. Analytics data includes user sessions and other custom events that you want to track in your app.
Storage Provides a simple mechanism for managing user content for your app in public, protected or private storage buckets with Amazon S3.
DataStore A programming model for leveraging shared and distributed data without writing additional code for offline and online scenarios, which makes working with distributed, cross-user data just as simple as working with local-only data.
API (REST) Provides a simple solution when making HTTP requests. It provides an automatic, lightweight signing process which complies with AWS Signature Version 4.
API (GraphQL) Interact with your GraphQL server or AWS AppSync API with an easy-to-use & configured GraphQL client.
Notifications Trigger push notifications to your app and record metrics in Pinpoint when users receive or open notifications.
Authenticator The Amplify Flutter Authenticator simplifies the process of authenticating users by providing a fully-customizable flow which just works. Simply wrap your app's authenticated route in an Authenticator component and the process of authenticating users and managing login sessions is handled for you.

Category / Platform Support

Category Android iOS Web Windows MacOS Linux
Analytics
API (REST)
API (GraphQL)
Authentication
DataStore 🔴 🔴 🔴 🔴
Storage
Notifications 🔴 🔴 🔴 🔴

Documentation

Flutter Development Guide

Amplify for Flutter is an open-source project and welcomes contributions from the Flutter community, see Contributing.

Prerequisites

Getting Started with Flutter app development and Amplify

  • Clone this repository
  • Install Amplify in a Flutter project
  • Add basic Amplify functionality to your project using one of the supported categories
  1. Open your Flutter project. If you do not have an active Flutter project, you can create one after installing the Flutter development tooling and running flutter create <project-name> in your terminal.

  2. Using the Amplify CLI, run amplify init from the root of your project:

See Amplify CLI Installation

==> amplify init
Note: It is recommended to run this command from the root of your app directory
? Enter a name for the project <project-name>
The following configuration will be applied:

Project information
| Name: <project-name>
| Environment: dev
| Default editor: Visual Studio Code
| App type: flutter
| Configuration file location: ./lib/

? Initialize the project with the above configuration? Yes
Using default provider  awscloudformation
? Select the authentication method you want to use: AWS profile

For more information on AWS Profiles, see:
https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html

? Please choose the profile you want to use default
  1. Add Amplify categories (choose defaults for this example):

    $ amplify add auth
    $ amplify add analytics
  2. Push changes to the cloud to provision the backend resources:

    $ amplify push
  3. In your pubspec.yaml file, add the following to dependencies:

Note: Do not include dependencies in your pubspec file that you are not using in your app. This can cause a configuration error in the underlying SDK.

dependencies:
  amplify_analytics_pinpoint: ^1.0.0
  amplify_auth_cognito: ^1.0.0
  amplify_authenticator: ^1.0.0
  amplify_flutter: ^1.0.0
  flutter:
    sdk: flutter
  1. From the terminal run
flutter pub get
  1. In your main.dart file, add:
import 'package:amplify_analytics_pinpoint/amplify_analytics_pinpoint.dart';
import 'package:amplify_auth_cognito/amplify_auth_cognito.dart';
import 'package:amplify_authenticator/amplify_authenticator.dart';
import 'package:amplify_flutter/amplify_flutter.dart';
import 'package:flutter/material.dart';

import 'amplifyconfiguration.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  var _amplifyConfigured = false;

  @override
  void initState() {
    super.initState();
    _configureAmplify();
  }

  Future<void> _configureAmplify() async {
    // Add Pinpoint and Cognito Plugins
    await Amplify.addPlugin(AmplifyAuthCognito());
    await Amplify.addPlugin(AmplifyAnalyticsPinpoint());

    // Once Plugins are added, configure Amplify
    await Amplify.configure(amplifyconfig);
    setState(() {
      _amplifyConfigured = true;
    });
  }

  // Send an event to Pinpoint
  Future<void> _recordEvent() async {
    final event = AnalyticsEvent('test');
    event.customProperties.addBoolProperty('boolKey', true);
    event.customProperties.addDoubleProperty('doubleKey', 10);
    event.customProperties.addIntProperty('intKey', 10);
    event.customProperties.addStringProperty('stringKey', 'stringValue');
    await Amplify.Analytics.recordEvent(event: event);
  }

  @override
  Widget build(BuildContext context) {
    return Authenticator(
      child: MaterialApp(
        builder: Authenticator.builder(),
        home: Scaffold(
          appBar: AppBar(
            title: const Text('Amplify Example App'),
          ),
          body: Center(
            child: Column(children: [
              const Padding(padding: EdgeInsets.all(5)),
              ElevatedButton(
                onPressed: _amplifyConfigured ? null : _configureAmplify,
                child: const Text('Configure Amplify'),
              ),
              ElevatedButton(
                onPressed: _amplifyConfigured ? _recordEvent : null,
                child: const Text('Record Event'),
              ),
            ]),
          ),
        ),
      ),
    );
  }
}
  1. Before you can run the app, some extra configuration may be required for each platform. Check out the Platform Setup guide to make sure you've completed the necessary steps.

  2. Run flutter run to launch your app on the connected device.

  3. Once the app is loaded, tap on Configure Amplify, then on Record Event a few times.

  4. To see the events you recoded, run amplify console analytics. This will open the Amazon Pinpoint console for your project in your default web browser. Within about a minute you should start seeing the events populating in the Events section of then Pinpoint console.

Congratulations, you've built your first Amplify app! 🎉

For further documentation and Amplify Category usage, see the documentation.


Flutter and the related logo are trademarks of Google LLC. We are not endorsed by or affiliated with Google LLC.

amplify-flutter's People

Contributors

aaronzylee avatar abhishek01039 avatar amplifiyer avatar asaarnak avatar ashish-nanda avatar bluprince13 avatar caravanat avatar cshfang avatar czaefferer avatar dnys1 avatar equartey avatar fjnoyp avatar haverchuck avatar hexch avatar huisf avatar jamesonwilliams avatar jordan-nelson avatar lorenzohidalgo avatar lukaselmer avatar marlonjd avatar mauerbac avatar mlabieniec avatar nikahsn avatar offlineprogrammer avatar passsy avatar ragingsquirrel3 avatar rubensdemelo avatar samaritan1011001 avatar skywardpixel avatar sutran avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.