Skip to content

Commit e314312

Browse files
ItzNotABugItzNotABug
authored
Merge pull request #1 from appwrite/feat-starter-kit
Feat: Starter Kit for Flutter
2 parents 4705d9b + ff0c12e commit e314312

File tree

206 files changed

+7507
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

206 files changed

+7507
-2
lines changed

‎.gitignore

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Miscellaneous
2+
*.class
3+
*.log
4+
*.pyc
5+
*.swp
6+
.DS_Store
7+
.atom/
8+
.build/
9+
.buildlog/
10+
.history
11+
.svn/
12+
.swiftpm/
13+
migrate_working_dir/
14+
15+
# IntelliJ related
16+
*.iml
17+
*.ipr
18+
*.iws
19+
.idea/
20+
21+
# The .vscode folder contains launch configuration and tasks you configure in
22+
# VS Code which you may wish to be included in version control, so this line
23+
# is commented out by default.
24+
.vscode/
25+
26+
# Flutter/Dart/Pub related
27+
**/doc/api/
28+
**/ios/Flutter/.last_build_id
29+
.dart_tool/
30+
.flutter-plugins
31+
.flutter-plugins-dependencies
32+
.pub-cache/
33+
.pub/
34+
/build/
35+
36+
# Symbolication related
37+
app.*.symbols
38+
39+
# Obfuscation related
40+
app.*.map.json
41+
42+
# Android Studio will place build artifacts here
43+
/android/app/debug
44+
/android/app/profile
45+
/android/app/release
46+
47+
# Apple
48+
**/*.xcodeproj/xcuserdata/
49+
**/*.xcworkspace/xcuserdata/
50+
**/.swiftpm/xcode/xcuserdata/
51+
**/*.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist
52+
**/*.xcworkspace/xcshareddata/*.xccheckout
53+
**/*.xcworkspace/xcshareddata/*.xcscmblueprint
54+
**/*.playground/**/timeline.xctimeline
55+
56+
# Build
57+
**/.build/
58+
**/Build/
59+
DerivedData/
60+
*.ipa
61+
62+
# Carthage
63+
Carthage/
64+
65+
# CocoaPods
66+
Pods/
67+
68+
# fastlane
69+
fastlane/report.xml
70+
fastlane/Preview.html
71+
fastlane/screenshots
72+
fastlane/test_output
73+
fastlane/sign&cert
74+
75+
# CSV
76+
*.orig
77+
.svn
78+
79+
# Other
80+
*~
81+
*.save
82+
._*
83+
*.bak

‎.metadata

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# This file tracks properties of this Flutter project.
2+
# Used by Flutter tool to assess capabilities and perform upgrades etc.
3+
#
4+
# This file should be version controlled and should not be manually edited.
5+
6+
version:
7+
revision: "17025dd88227cd9532c33fa78f5250d548d87e9a"
8+
channel: "stable"
9+
10+
project_type: app
11+
12+
# Tracks metadata for the flutter migrate command
13+
migration:
14+
platforms:
15+
- platform: root
16+
create_revision: 17025dd88227cd9532c33fa78f5250d548d87e9a
17+
base_revision: 17025dd88227cd9532c33fa78f5250d548d87e9a
18+
- platform: android
19+
create_revision: 17025dd88227cd9532c33fa78f5250d548d87e9a
20+
base_revision: 17025dd88227cd9532c33fa78f5250d548d87e9a
21+
- platform: ios
22+
create_revision: 17025dd88227cd9532c33fa78f5250d548d87e9a
23+
base_revision: 17025dd88227cd9532c33fa78f5250d548d87e9a
24+
- platform: linux
25+
create_revision: 17025dd88227cd9532c33fa78f5250d548d87e9a
26+
base_revision: 17025dd88227cd9532c33fa78f5250d548d87e9a
27+
- platform: macos
28+
create_revision: 17025dd88227cd9532c33fa78f5250d548d87e9a
29+
base_revision: 17025dd88227cd9532c33fa78f5250d548d87e9a
30+
- platform: web
31+
create_revision: 17025dd88227cd9532c33fa78f5250d548d87e9a
32+
base_revision: 17025dd88227cd9532c33fa78f5250d548d87e9a
33+
- platform: windows
34+
create_revision: 17025dd88227cd9532c33fa78f5250d548d87e9a
35+
base_revision: 17025dd88227cd9532c33fa78f5250d548d87e9a
36+
37+
# User provided section
38+
39+
# List of Local paths (relative to this file) that should be
40+
# ignored by the migrate tool.
41+
#
42+
# Files that are not part of the templates will be ignored by default.
43+
unmanaged_files:
44+
- 'lib/main.dart'
45+
- 'ios/Runner.xcodeproj/project.pbxproj'

‎README.md

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,50 @@
1-
# starter-for-flutter
2-
Appwrite's starter kit for Flutter 💙
1+
# Flutter Starter Kit with Appwrite
2+
3+
Kickstart your Flutter development with this ready-to-use starter project integrated
4+
with [Appwrite](https://appwrite.io).
5+
6+
This guide will help you quickly set up, customize, and build your Flutter app.
7+
8+
---
9+
10+
## 🚀 Getting Started
11+
12+
### Clone the Project
13+
14+
Clone this repository to your local machine using Git or directly from `Android Studio`:
15+
16+
```bash
17+
git clone https://github.com/appwrite/starter-for-flutter
18+
```
19+
20+
Alternatively, open the repository URL in `Android Studio` to clone it directly.
21+
22+
---
23+
24+
## 🛠️ Development Guide
25+
26+
1. **Configure Appwrite**
27+
Navigate to `lib/data/repository/appwrite_repository.dart` and update the values to match your
28+
Appwrite project credentials.
29+
30+
2. **Customize as Needed**
31+
Modify the starter kit to suit your app's requirements. Adjust UI, features, or backend
32+
integrations as per your needs.
33+
34+
3. **Run the App**
35+
Select a target device (emulator or a connected physical device) in `Android Studio`, and
36+
click **Run** to start the app.
37+
38+
---
39+
40+
## 📦 Building for Production
41+
42+
Follow the official Flutter guide on deploying an app to
43+
production : https://docs.flutter.dev/deployment
44+
45+
---
46+
47+
## 💡 Additional Notes
48+
49+
- This starter project is designed to streamline your Android development with Appwrite.
50+
- Refer to the [Appwrite Documentation](https://appwrite.io/docs) for detailed integration guidance.

‎analysis_options.yaml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# This file configures the analyzer, which statically analyzes Dart code to
2+
# check for errors, warnings, and lints.
3+
#
4+
# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
5+
# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
6+
# invoked from the command line by running `flutter analyze`.
7+
8+
# The following line activates a set of recommended lints for Flutter apps,
9+
# packages, and plugins designed to encourage good coding practices.
10+
include: package:flutter_lints/flutter.yaml
11+
12+
linter:
13+
# The lint rules applied to this project can be customized in the
14+
# section below to disable rules from the `package:flutter_lints/flutter.yaml`
15+
# included above or to enable additional rules. A list of all available lints
16+
# and their documentation is published at https://dart.dev/lints.
17+
#
18+
# Instead of disabling a lint rule for the entire project in the
19+
# section below, it can also be suppressed for a single line of code
20+
# or a specific dart file by using the `// ignore: name_of_lint` and
21+
# `// ignore_for_file: name_of_lint` syntax on the line or in the file
22+
# producing the lint.
23+
rules:
24+
# avoid_print: false # Uncomment to disable the `avoid_print` rule
25+
# prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule
26+
27+
# Additional information about this file can be found at
28+
# https://dart.dev/guides/language/analysis-options

‎android/.gitignore

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
gradle-wrapper.jar
2+
/.gradle
3+
/captures/
4+
/gradlew
5+
/gradlew.bat
6+
/local.properties
7+
GeneratedPluginRegistrant.java
8+
9+
# Remember to never publicly share your keystore.
10+
# See https://flutter.dev/to/reference-keystore
11+
key.properties
12+
**/*.keystore
13+
**/*.jks

‎android/app/build.gradle

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
plugins {
2+
id "com.android.application"
3+
id "kotlin-android"
4+
id "dev.flutter.flutter-gradle-plugin"
5+
}
6+
7+
android {
8+
ndkVersion = "25.1.8937393"
9+
namespace = "io.appwrite.flutter"
10+
compileSdk = flutter.compileSdkVersion
11+
12+
compileOptions {
13+
sourceCompatibility = JavaVersion.VERSION_17
14+
targetCompatibility = JavaVersion.VERSION_17
15+
}
16+
17+
kotlinOptions {
18+
jvmTarget = JavaVersion.VERSION_17
19+
}
20+
21+
defaultConfig {
22+
applicationId = "io.appwrite.flutter"
23+
24+
minSdk = flutter.minSdkVersion
25+
targetSdk = flutter.targetSdkVersion
26+
27+
versionCode = flutter.versionCode
28+
versionName = flutter.versionName
29+
}
30+
31+
buildTypes {
32+
release {
33+
signingConfig = signingConfigs.debug
34+
}
35+
}
36+
}
37+
38+
flutter {
39+
source = "../.."
40+
}

‎android/app/src/main/AndroidManifest.xml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
2+
3+
<uses-permission android:name="android.permission.INTERNET" />
4+
5+
<application
6+
android:name="${applicationName}"
7+
android:icon="@mipmap/ic_launcher"
8+
android:label="AppwriteStarterKit">
9+
<activity
10+
android:name=".MainActivity"
11+
android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
12+
android:exported="true"
13+
android:hardwareAccelerated="true"
14+
android:launchMode="singleTop"
15+
android:taskAffinity=""
16+
android:theme="@style/LaunchTheme"
17+
android:windowSoftInputMode="adjustResize">
18+
<!-- Specifies an Android theme to apply to this Activity as soon as
19+
the Android process has started. This theme is visible to the user
20+
while the Flutter UI initializes. After that, this theme continues
21+
to determine the Window background behind the Flutter UI. -->
22+
<meta-data
23+
android:name="io.flutter.embedding.android.NormalTheme"
24+
android:resource="@style/NormalTheme" />
25+
<intent-filter>
26+
<action android:name="android.intent.action.MAIN" />
27+
<category android:name="android.intent.category.LAUNCHER" />
28+
</intent-filter>
29+
</activity>
30+
<!-- Don't delete the meta-data below.
31+
This is used by the Flutter tool to generate GeneratedPluginRegistrant.java -->
32+
<meta-data
33+
android:name="flutterEmbedding"
34+
android:value="2" />
35+
</application>
36+
<queries>
37+
<intent>
38+
<action android:name="android.intent.action.PROCESS_TEXT" />
39+
<data android:mimeType="text/plain" />
40+
</intent>
41+
</queries>
42+
</manifest>

‎android/app/src/main/kotlin/io/appwrite/flutter/MainActivity.kt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
package io.appwrite.flutter
2+
3+
import io.flutter.embedding.android.FlutterActivity
4+
5+
class MainActivity: FlutterActivity()

‎android/app/src/main/res/drawable-hdpi/branding.png

7.59 KB
Loading

‎android/app/src/main/res/drawable-hdpi/splash.png

4.98 KB
Loading

0 commit comments

Comments
 (0)