You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+49-90Lines changed: 49 additions & 90 deletions
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ We are iterating and looking for feedback and collaboration, so please [**let us
12
12
13
13
⚠️ **Amplify Flutter v1 is now in Maintenance Mode until April 30th, 2025. This means that we will continue to include updates to ensure compatibility with backend services and security. No new features will be introduced in v1.**
14
14
15
-
Please use the latest version (v2) of Amplify Flutter. If you are currently using v1, follow [these instructions](https://docs.amplify.aws/lib/project-setup/upgrade-guide/q/platform/flutter/) to upgrade to v2.
15
+
Please use the latest version (Gen 2) of Amplify Flutter. If you are currently using v1, follow [these instructions](https://docs.amplify.aws/lib/project-setup/upgrade-guide/q/platform/flutter/) to upgrade to v2.
16
16
17
17
## Supported Amplify Libraries
18
18
@@ -56,9 +56,8 @@ We follow [semantic versioning for updating our dependencies](https://semver.org
56
56
57
57
## Documentation
58
58
59
-
-[Getting Started with Amplify Flutter](https://docs.amplify.aws/start/q/integration/flutter)
59
+
-[Getting Started with Amplify Flutter](https://docs.amplify.aws/flutter/start/quickstart/)
60
60
-[Amplify Framework](https://docs.amplify.aws/)
61
-
-[Install the Amplify CLI](https://docs.amplify.aws/lib/project-setup/prereq/q/platform/flutter#install-and-configure-the-amplify-cli)
62
61
-[Contributing to Amplify Flutter](CONTRIBUTING.md)
63
62
64
63
## Flutter Development Guide
@@ -68,116 +67,76 @@ Amplify for Flutter is an open-source project and welcomes contributions from th
1. Open your Flutter project. If you do not have an active Flutter project, you can create one after installing the [Flutter development tooling](https://flutter.dev/docs/get-started/install) and running `flutter create <project-name>` in your terminal.
76
76
77
-
2.Using the Amplify CLI, run `amplify init` from the root of your project:
77
+
2.Run the following to create an amplify project:
78
78
79
-
If you have not configured the Amplify CLI, check out our documentation at [Amplify CLI Installation](https://docs.amplify.aws/lib/project-setup/prereq/q/platform/flutter#install-and-configure-the-amplify-cli).
79
+
`npm create amplify@latest -y`
80
80
81
-
```bash
82
-
==> amplify init
83
-
Note: It is recommended to run this command from the root of your app directory
84
-
? Enter a name for the project <project-name>
85
-
The following configuration will be applied:
81
+
4. To use the Authenticator, you need to add the following dependencies to your project:
86
82
87
-
Project information
88
-
| Name: <project-name>
89
-
| Environment: dev
90
-
| Default editor: Visual Studio Code
91
-
| App type: flutter
92
-
| Configuration file location: ./lib/
83
+
```yaml
84
+
dependencies:
85
+
amplify_auth_cognito: ^2.0.0
86
+
amplify_authenticator: ^2.0.0
87
+
amplify_flutter: ^2.0.0
88
+
flutter:
89
+
sdk: flutter
90
+
```
93
91
94
-
? Initialize the project with the above configuration? Yes
95
-
Using default provider awscloudformation
96
-
? Select the authentication method you want to use: AWS profile
? Please choose the profile you want to use default
102
-
```
103
-
104
-
4. Add Amplify categories (choose defaults for this example):
105
-
106
-
```bash
107
-
$ amplify add auth # Choose default configuration after entering this command in your terminal.
108
-
```
109
-
110
-
5. Push changes to the cloud to provision the backend resources:
111
-
112
-
```bash
113
-
$ amplify push
114
-
```
115
-
116
-
6. In your pubspec.yaml file, add the following to `dependencies`:
117
-
118
-
> 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.
@@ -186,17 +145,17 @@ class _MyAppState extends State<MyApp> {
186
145
}
187
146
```
188
147
189
-
9. Since Amplify Flutter supports 6 platforms with Flutter including iOS, Android, Web, and Desktop, some extra configuration may be required for each platform. Check out the [Platform Setup](https://docs.amplify.aws/lib/project-setup/platform-setup/q/platform/flutter/) guide to make sure you've completed the necessary steps.
148
+
7. Deploy your backend use Amplify's per-developer cloud sandbox. This feature provides a separate backend environment for every developer on a team, ideal for local development and testing. To run your application with a sandbox environment, you can run the following command:
190
149
191
-
10. Run `flutter run` to launch your app on the connected device.
11. Once the app is loaded, tap on **Configure Amplify**, then on **Record Event** a few times.
152
+
8. Since Amplify Flutter supports 6 platforms with Flutter including iOS, Android, Web, and Desktop, some extra configuration may be required for each platform. Check out the [Platform Setup](https://docs.amplify.aws/flutter/start/platform-setup/) guide to make sure you've completed the necessary steps.
194
153
195
-
12. 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.
154
+
9. Run `flutter run` to launch your app on the connected device.
196
155
197
156
Congratulations, you've built your first Amplify app! 🎉
198
157
199
-
For further documentation and Amplify Category usage, see the [documentation](https://docs.amplify.aws/lib/q/platform/flutter).
158
+
For further documentation and Amplify Category usage, see the [documentation](https://docs.amplify.aws/flutter/).
0 commit comments