diff --git a/.gitignore b/.gitignore index a8e938c..01301aa 100644 --- a/.gitignore +++ b/.gitignore @@ -45,3 +45,5 @@ app.*.map.json /android/app/debug /android/app/profile /android/app/release + +constants.dart \ No newline at end of file diff --git a/README.md b/README.md index 946e20e..d68e46f 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,54 @@ -# demo_todo_with_flutter +# 🔖 Todo With Flutter -A new Flutter project. +A simple todo app built with Flutter and Appwrite -## Getting Started +## 🎬 Getting Started -This project is a starting point for a Flutter application. +Appwrite is an end-to-end backend server for Web, Mobile, Native, or Backend apps packaged as a set of Docker microservices. Appwrite abstracts the complexity and repetitiveness required to build a modern backend API from scratch and allows you to build secure apps faster. -A few resources to get you started if this is your first Flutter project: +### 🤘 Install Appwrite -- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) -- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) +Follow our simple [Installation Guide](https://appwrite.io/docs/installation) to get Appwrite up and running in no time. You can either deploy Appwrite on your local machine or, on any cloud provider of your choice. -For help getting started with Flutter development, view the -[online documentation](https://docs.flutter.dev/), which offers tutorials, -samples, guidance on mobile development, and a full API reference. +``` +Note: If you setup Appwrite on your local machine, you will need to create a public IP so that your hosted frontend can access it. +``` + +We need to make a few configuration changes to your Appwrite server. + +1. Add a new Flutter App (Android or iOS or both) in Appwrite: + + ![Console - Add platform](docs/Console%20-%20Add%20platform.png) + + 1. Android - `io.appwrite.demo_todo_with_flutter` + 2. iOS/Mac OS - `io.appwrite.demoTodoWithFlutter` + +2. Create a project in the Appwrite Console with id `demo-todos`. + +3. Use the [Appwrite CLI](https://appwrite.io/docs/command-line) to deploy the required collections. + + ```shell + appwrite deploy collections + ``` + +### 🚀 Run locally + +Follow these instructions to run the demo app locally. + +```shell +git clone https://github.com/appwrite/demo-todo-with-flutter.git +cd demo-todo-with-flutter +``` + +Make `lib/constant.dart` using `lib/constants.dart.example` as a template. + +Now run the following commands and you should be good to go 💪🏼 + +```shell +flutter pub get +flutter run +``` + +## 🤕 Support + +If you get stuck anywhere, hop onto one of our [support channels in discord](https://discord.com/invite/GSeTUeA) and we'd be delighted to help you out 🤝 diff --git a/android/app/build.gradle b/android/app/build.gradle index 7a4cae5..bcb4d68 100644 --- a/android/app/build.gradle +++ b/android/app/build.gradle @@ -44,7 +44,7 @@ android { defaultConfig { // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html). - applicationId "com.example.demo_todo_with_flutter" + applicationId "io.appwrite.demo_todo_with_flutter" // You can update the following values to match your application needs. // For more information, see: https://docs.flutter.dev/deployment/android#reviewing-the-build-configuration. minSdkVersion flutter.minSdkVersion diff --git a/android/app/src/debug/AndroidManifest.xml b/android/app/src/debug/AndroidManifest.xml index bf8afed..ff364d4 100644 --- a/android/app/src/debug/AndroidManifest.xml +++ b/android/app/src/debug/AndroidManifest.xml @@ -1,5 +1,5 @@ + package="io.appwrite.demo_todo_with_flutter">