Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: Update README #39

Merged
merged 1 commit into from
Aug 17, 2020
Merged

doc: Update README #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,24 @@

## Amplify Flutter (Developer Preview)

AWS Amplify provides a declarative and easy-to-use interface across different categories of cloud operations. AWS Amplify goes well with any Flutter based frontend workflow, and React Native for mobile developers. 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.
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](https://docs.amplify.aws) for further details about the Amplify Framework.

⚠️ **Amplify for Flutter is in developer preview and not yet recommended for production.**

See [AWS Amplify](https://docs.amplify.aws) for further details about the Amplify Framework.
We are iterating and looking for feedback and collaboration, so please [**let us know your feedback**](https://github.com/aws-amplify/amplify-flutter/issues/5) on our direction and roadmap.

## Supported Amplify Categories

- [**Authentication**](https://docs.amplify.aws/lib/auth/getting-started/q/platform/flutter): APIs and building blocks to create user authentication experiences.
- [**Analytics**](https://docs.amplify.aws/lib/analytics/getting-started/q/platform/flutter): Collect analytics data for your app. Analytics data includes user sessions and other custom events that you want to track in your app.
- [**Storage**](https://docs.amplify.aws/lib/storage/getting-started/q/platform/flutter): Provides a simple mechanism for managing user content for your app in public, protected or private storage buckets.

### To Be Implmented
### To Be Implemented

- API (REST/GraphQL)
- Predictions
- Datastore
- Hub Events (Listening to the Amplify events)

> Amplify for Flutter is in preview, which should be considered an alpha version and not recommended for production deployments. We are iterating and looking for feedback and collaboration, so please [**LET US KNOW YOUR FEEDBACK**](https://github.com/aws-amplify/amplify-flutter/issues/5) on our direction and roadmap.

Amplify for Flutter currently supports **iOS** and **Android** platforms.

Expand All @@ -38,7 +38,7 @@ Amplify for Flutter currently supports **iOS** and **Android** platforms.

## Flutter Development Guide

> Amplify for Flutter is an open-source project and welcomes contributions from the Flutter community, see [Contributing](CONTRIBUTING.md).
Amplify for Flutter is an open-source project and welcomes contributions from the Flutter community, see [Contributing](CONTRIBUTING.md).

#### Prerequisites

Expand Down Expand Up @@ -99,7 +99,7 @@ dependencies:
6. From the terminal run

```bash
$ flutter pub get
flutter pub get
```

7. In your main.dart file, add:
Expand Down Expand Up @@ -202,7 +202,7 @@ This ensures that your Flutter project is running the same ios version that the

8. From the root of your project, execute `flutter run` in the terminal.

> Make sure that an Android or iOS device is already running; this can be a virutal device started from Android Studio.
> 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.

Expand Down