Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/appwrite/playground-for-flutter
Simple examples that help you get started with Appwrite + Flutter (=❤️)
https://github.com/appwrite/playground-for-flutter
appwrite baas flutter hacktoberfest
Last synced: 2 months ago
JSON representation
Simple examples that help you get started with Appwrite + Flutter (=❤️)
- Host: GitHub
- URL: https://github.com/appwrite/playground-for-flutter
- Owner: appwrite
- Created: 2020-04-08T16:35:37.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-09T07:08:06.000Z (7 months ago)
- Last Synced: 2024-09-27T06:40:15.403Z (3 months ago)
- Topics: appwrite, baas, flutter, hacktoberfest
- Language: C++
- Homepage: https://appwrite.io
- Size: 398 KB
- Stars: 120
- Watchers: 20
- Forks: 40
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-appwrite - Playground for Flutter
README
# 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](https://github.com/appwrite/playground-for-dart) and [Dart SDK](https://github.com/appwrite/sdk-for-dart)
## 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](https://appwrite.io/docs/command-line) 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:
```bash
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:
```bash
appwrite deploy collection --all --yes
```
4. Use the Appwrite CLI to deploy the Bucket:
```bash
appwrite deploy bucket --all --yes
```
5. Use the Appwrite CLI to create the test user:
```bash
appwrite users create --email "[email protected]" --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](https://github.com/appwrite/appwrite/blob/master/CONTRIBUTING.md).
## Security
For security issues, kindly email us [[email protected]](mailto:[email protected]) instead of posting a public issue in GitHub.
## Follow Us
Join our growing community around the world! Follow us on [Twitter](https://twitter.com/appwrite), [Facebook Page](https://www.facebook.com/appwrite.io), [Facebook Group](https://www.facebook.com/groups/appwrite.developers/) or join our [Discord Server](https://appwrite.io/discord) for more help, ideas and discussions.