README.md

Appwrite's Flutter Playground 🎮

Appwrite playground is a simple way to explore the Appwrite API & Appwrite Flutter SDK. Use the source code of this page to learn how to use the different Appwrite Flutter SDK features.

This is Appwrite Flutter integration. For Dart server side integration please look at our Dart Playground and Dart SDK

Get Started

The lib/main.dart file in this repository contains all the playground examples and source code.

You can learn how to to integrate your Appwrite Flutter SDK in your project and see how different features of the SDK can be used.

This playground doesn't include any Appwrite best practices but rather intended to show the most simple examples and use cases of using the Appwrite API in your app.

Setup

We recommend using the Appwrite CLI to setup your Appwrite project.

1. Create a Project in the Appwrite Console with ID playground-for-flutter. If you're using a different Project ID, make sure to use the same ID in the following commands, the appwrite.json, and android/app/src/main/AndroidManifest.xml.

2. Create a Flutter Platform for each platform you'd like to test:

   appwrite projects createPlatform --projectId playground-for-flutter --type flutter-ios --name "com.example.playgroundForFlutter" --key "com.example.playgroundForFlutter"
   appwrite projects createPlatform --projectId playground-for-flutter --type flutter-android --name "com.example.playground_for_flutter" --key "com.example.playground_for_flutter"
   appwrite projects createPlatform --projectId playground-for-flutter --type flutter-macos --name "com.example.playgroundForFlutter" --key "com.example.playgroundForFlutter"
   appwrite projects createPlatform --projectId playground-for-flutter --type flutter-windows --name "playground_for_flutter" --key "playground_for_flutter"
   appwrite projects createPlatform --projectId playground-for-flutter --type flutter-linux --name "playground_for_flutter" --key "playground_for_flutter"

3. Use the Appwrite CLI to deploy the Database and Collection:

   appwrite deploy collection --all --yes

4. Use the Appwrite CLI to deploy the Bucket:

   appwrite deploy bucket --all --yes

5. Use the Appwrite CLI to create the test user:

   appwrite users create --email "user@appwrite.io" --password "password" --name "Test User"

6. Create lib/constants.dart using lib/constants.dart.example as a template.

Contributing

All code contributions - including those of people having commit access - must go through a pull request and approved by a core developer before being merged. This is to ensure proper review of all the code.

We truly ❤️ pull requests! If you wish to help, you can learn more about how you can contribute to this project in the contribution guide.

Security

For security issues, kindly email us security@appwrite.io instead of posting a public issue in GitHub.

Follow Us

Join our growing community around the world! Follow us on Twitter, Facebook Page, Facebook Group or join our Discord Server for more help, ideas and discussions.