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.
-
Authentication: Create user authentication experiences with Amazon Cognito
-
Analytics: Collect analytics data with Amazon Pinpoint
-
Storage: Store user content with Amazon S3
- API (REST/GraphQL)
- Predictions
- Datastore
- Hub Events (Listening to the Amplify events)
- iOS Error Events in Amplify Analytics
Amplify for Flutter is in preview, and is not recommended for production use at this time. During this phase, we are iterating on the code base, and looking for your feedback and collaboration. WE'D LOVE TO GET YOUR FEEDBACK! :-)..
Amplify for Flutter currently supports iOS and Android platforms.
- Getting Started with Amplify Flutter
- Amplify Framework
- Install the Amplify CLI
- Contributing to Amplify Flutter
Amplify for Flutter is an open-source project and welcomes contributions from the Flutter community, see Contributing.
- Clone this repository
- Install Amplify in a Flutter project
- Add basic Amplify functionality to your project using one of the supported categories
-
git clone [email protected]:aws-amplify/amplify-flutter.git -
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. -
Using the Amplify CLI, run
amplify initfrom the root of your project:
==> amplify init
Note: It is recommended to run this command from the root of your app directory
? Enter a name for the project helloAmplify
? Enter a name for the environment dev
? Choose your default editor: Visual Studio Code
? Choose the type of app that you\'re building flutter
Please tell us about your project
⚠️ Flutter project support in the Amplify CLI is in DEVELOPER PREVIEW status.
Only the following resource types are supported:
* Auth
* Analytics
* Storage
? Where do you want to store your configuration file? ./lib/-
Add Amplify categories (choose defaults for this example):
$ amplify add auth $ amplify add analytics
-
In your pubspec.yaml file, add the following to
dependencies:
Note: Do not include dependencies in your
pubspecfile that you are not using in your app. This can cause a configuration error in the underlying SDK.
dependencies:
flutter:
sdk: flutter
amplify_core:
path: /{path to your local amplify-flutter}/amplify-flutter/packages/amplify_core
amplify_analytics_pinpoint:
path: /{path to your local amplify-flutter}/amplify-flutter/packages/amplify_analytics_pinpoint
amplify_auth_cognito:
path: /{path to your local amplify-flutter}/amplify-flutter/packages/amplify_auth_cognito- From the terminal run
flutter pub get- In your main.dart file, add:
import 'package:amplify_auth_cognito/amplify_auth_cognito.dart';
import 'package:flutter/material.dart';
import 'package:amplify_core/amplify_core.dart';
import 'package:amplify_analytics_pinpoint/amplify_analytics_pinpoint.dart';
import 'amplifyconfiguration.dart';
void main() {
runApp(MyApp());
}
class MyApp extends StatefulWidget {
@override
_MyAppState createState() => _MyAppState();
}
class _MyAppState extends State<MyApp> {
bool _amplifyConfigured = false;
// Instantiate Amplify
Amplify amplifyInstance = new Amplify();
@override
void initState() {
super.initState();
}
void _configureAmplify() async {
if (!mounted) return;
// Add Pinpoint and Cognito Plugins
AmplifyAnalyticsPinpoint analyticsPlugin = AmplifyAnalyticsPinpoint();
AmplifyAuthCognito authPlugin = AmplifyAuthCognito();
amplifyInstance.addPlugin(authPlugins: [authPlugin]);
amplifyInstance.addPlugin(analyticsPlugins: [analyticsPlugin]);
// Once Plugins are added, configure Amplify
await amplifyInstance.configure(amplifyconfig);
try {
setState(() {
_amplifyConfigured = true;
});
} catch (e) {
print(e);
}
}
// Send an event to Pinpoint
void _recordEvent() async {
AnalyticsEvent event = AnalyticsEvent("test");
event.properties.addBoolProperty("boolKey", true);
event.properties.addDoubleProperty("doubleKey", 10.0);
event.properties.addIntProperty("intKey", 10);
event.properties.addStringProperty("stringKey", "stringValue");
Amplify.Analytics.recordEvent(event: event);
}
@override
Widget build(BuildContext context) {
return MaterialApp(
home: Scaffold(
appBar: AppBar(
title: const Text('Amplify Core example app'),
),
body: ListView(padding: EdgeInsets.all(10.0), children: <Widget>[
Center(
child: Column (
children: [
const Padding(padding: EdgeInsets.all(5.0)),
RaisedButton(
onPressed: _amplifyConfigured ? null : _configureAmplify,
child: const Text('configure Amplify')
),
RaisedButton(
onPressed: _amplifyConfigured ? _recordEvent : null,
child: const Text('record event')
)
]
),
)
])
)
);
}
}For iOS builds complete the following steps (from the root of your project):
rm ios/Podfileflutter build ios- Modify the
ios/Podfileand replace the second line with:platform :ios, '11.0'.
This ensures that your Flutter project is running the same ios version that the Amplify plugins are built on.
- From the root of your project, execute
flutter runin the terminal.
Make sure that an Android or iOS device is already running; this can be a virtual device started from Android Studio.
Click Configure Amplify, then Record Event. From the terminal (in the root of your project) 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.
For further documentation and Amplify Category API usage, see the documentation.
Flutter and the related logo are trademarks of Google LLC. We are not endorsed by or affiliated with Google LLC.