-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Full-featured Kotbase Notes MVVM example app
With shared Compose Multiplatform UI
- Loading branch information
Showing
76 changed files
with
3,168 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
*.iml | ||
.gradle | ||
local.properties | ||
.idea | ||
.DS_Store | ||
build | ||
/captures | ||
.externalNativeBuild | ||
.cxx | ||
iosApp/Podfile.lock | ||
iosApp/Pods/* | ||
iosApp/iosApp.xcworkspace/* | ||
iosApp/iosApp.xcodeproj/* | ||
!iosApp/iosApp.xcodeproj/project.pbxproj | ||
kotbase-notes/kotbase_notes.podspec |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# Kotbase Notes | ||
|
||
The Kotbase Notes app is a full-featured MVVM Kotlin Multiplatform app using Kotbase for local storage. The app also | ||
connects to [Couchbase Sync Gateway](https://www.couchbase.com/products/sync-gateway/) to authenticate a user and | ||
synchronize data to a [Couchbase Server](https://www.couchbase.com/products/server/) backend database and between devices. | ||
|
||
The app targets Android, iOS, and JVM Desktop platforms. | ||
|
||
* `/kotbase-notes` is for code that will be shared across the Compose Multiplatform application. | ||
It contains several subfolders: | ||
- `commonMain` is for code that’s common for all targets. | ||
- Other folders are for Kotlin code that will be compiled for only the platform indicated in the folder name. | ||
For example, if you want to use Apple’s CoreCrypto for the iOS part of your Kotlin app, | ||
`iosMain` would be the right folder for such calls. | ||
|
||
* `/iosApp` contains the iOS Xcode project. Even if you’re sharing your UI with Compose Multiplatform, you need this | ||
entry point for your iOS app. This is also where you should add SwiftUI code for your project. | ||
- The iOS app uses CocoaPods to link to the Kotlin shared framework as well as the CouchbaseLite native framework | ||
dependency. | ||
|
||
## Configure Sync Gateway | ||
|
||
You need to configure [Couchbase Server]( | ||
https://docs.couchbase.com/server/current/getting-started/do-a-quick-install.html) and [Sync Gateway]( | ||
https://docs.couchbase.com/sync-gateway/current/get-started-install.html) for the app to authenticate and connect to | ||
sync data. | ||
|
||
* Create a bucket `kotbase-notes`. | ||
* Create a scope `user-<username>`. | ||
* Create a `notes` collection within this scope. | ||
* Configure the database `kotbase-notes` in Sync Gateway for the user's scope and collection. | ||
* Use this sync function: | ||
```javascript | ||
function(doc, oldDoc, meta) { | ||
channelId = "user=<username>.notes"; | ||
// Assign document to channel | ||
channel(channelId); | ||
// Grant user access to channel | ||
access("<username>", channelId); | ||
} | ||
``` | ||
* Create user `<username>` in Sync Gateway. | ||
* Set the password. | ||
* Set collection access for `user-<username>.notes` with `"admin_channels": ["user=<username>.notes"]`. | ||
|
||
## Roadmap | ||
|
||
* [ ] SwiftUI for iOS | ||
* [ ] Sync Gateway configuration app |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
plugins { | ||
// this is necessary to avoid the plugins to be loaded multiple times | ||
// in each subproject's classloader | ||
alias(libs.plugins.android.application) apply false | ||
alias(libs.plugins.android.library) apply false | ||
alias(libs.plugins.jetbrains.compose) apply false | ||
alias(libs.plugins.kotlin.multiplatform) apply false | ||
alias(libs.plugins.kotlin.native.cocoapods) apply false | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Gradle | ||
org.gradle.jvmargs=-Xmx2048M -Dfile.encoding=UTF-8 -Dkotlin.daemon.jvm.options\="-Xmx2048M" | ||
|
||
# Kotlin | ||
kotlin.code.style=official | ||
|
||
# MPP | ||
kotlin.mpp.enableCInteropCommonization=true | ||
|
||
# Android | ||
android.useAndroidX=true | ||
android.nonTransitiveRClass=true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
[versions] | ||
agp = "8.2.2" | ||
android-compileSdk = "34" | ||
android-minSdk = "24" | ||
android-targetSdk = "34" | ||
androidx-activity-compose = "1.8.2" | ||
compose = "1.6.1" | ||
compose-plugin = "1.5.12" | ||
coroutines = "1.7.3" | ||
couchbase-lite-objc = "3.1.4" | ||
koin = "3.5.3" | ||
kotlin = "1.9.22" | ||
ktor = "2.3.8" | ||
|
||
[plugins] | ||
android-application = { id = "com.android.application", version.ref = "agp" } | ||
android-library = { id = "com.android.library", version.ref = "agp" } | ||
jetbrains-compose = { id = "org.jetbrains.compose", version.ref = "compose-plugin" } | ||
kotlin-multiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" } | ||
kotlin-native-cocoapods = { id = "org.jetbrains.kotlin.native.cocoapods", version.ref = "kotlin" } | ||
kotlinx-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" } | ||
skie = { id = "co.touchlab.skie", version = "0.6.1" } | ||
|
||
[libraries] | ||
androidx-activity-compose = { module = "androidx.activity:activity-compose", version.ref = "androidx-activity-compose" } | ||
compose-ui-tooling = { module = "androidx.compose.ui:ui-tooling", version.ref = "compose" } | ||
compose-ui-tooling-preview = { module = "androidx.compose.ui:ui-tooling-preview", version.ref = "compose" } | ||
koin-core = { module = "io.insert-koin:koin-core", version.ref = "koin" } | ||
koin-compose = { module = "io.insert-koin:koin-compose", version = "1.1.2" } | ||
koin-android = { module = "io.insert-koin:koin-android", version.ref = "koin" } | ||
koin-androidx-compose = { module = "io.insert-koin:koin-androidx-compose", version.ref = "koin" } | ||
kotbase = { module = "dev.kotbase:couchbase-lite-ktx", version = "3.1.3-1.1.0" } | ||
kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "coroutines" } | ||
kotlinx-coroutines-swing = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-swing", version.ref = "coroutines" } | ||
kotlinx-serialization-json = { module = "org.jetbrains.kotlinx:kotlinx-serialization-json", version = "1.6.2" } | ||
kotlinx-datetime = { module = "org.jetbrains.kotlinx:kotlinx-datetime", version = "0.5.0" } | ||
ktor-client-core = { module = "io.ktor:ktor-client-core", version.ref = "ktor" } | ||
ktor-client-cio = { module = "io.ktor:ktor-client-cio", version.ref = "ktor" } |
Binary file not shown.
7 changes: 7 additions & 0 deletions
7
examples/kotbase-notes/gradle/wrapper/gradle-wrapper.properties
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
distributionBase=GRADLE_USER_HOME | ||
distributionPath=wrapper/dists | ||
distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-bin.zip | ||
networkTimeout=10000 | ||
validateDistributionUrl=true | ||
zipStoreBase=GRADLE_USER_HOME | ||
zipStorePath=wrapper/dists |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,249 @@ | ||
#!/bin/sh | ||
|
||
# | ||
# Copyright © 2015-2021 the original authors. | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# https://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
# | ||
|
||
############################################################################## | ||
# | ||
# Gradle start up script for POSIX generated by Gradle. | ||
# | ||
# Important for running: | ||
# | ||
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is | ||
# noncompliant, but you have some other compliant shell such as ksh or | ||
# bash, then to run this script, type that shell name before the whole | ||
# command line, like: | ||
# | ||
# ksh Gradle | ||
# | ||
# Busybox and similar reduced shells will NOT work, because this script | ||
# requires all of these POSIX shell features: | ||
# * functions; | ||
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», | ||
# «${var#prefix}», «${var%suffix}», and «$( cmd )»; | ||
# * compound commands having a testable exit status, especially «case»; | ||
# * various built-in commands including «command», «set», and «ulimit». | ||
# | ||
# Important for patching: | ||
# | ||
# (2) This script targets any POSIX shell, so it avoids extensions provided | ||
# by Bash, Ksh, etc; in particular arrays are avoided. | ||
# | ||
# The "traditional" practice of packing multiple parameters into a | ||
# space-separated string is a well documented source of bugs and security | ||
# problems, so this is (mostly) avoided, by progressively accumulating | ||
# options in "$@", and eventually passing that to Java. | ||
# | ||
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, | ||
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; | ||
# see the in-line comments for details. | ||
# | ||
# There are tweaks for specific operating systems such as AIX, CygWin, | ||
# Darwin, MinGW, and NonStop. | ||
# | ||
# (3) This script is generated from the Groovy template | ||
# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt | ||
# within the Gradle project. | ||
# | ||
# You can find Gradle at https://github.com/gradle/gradle/. | ||
# | ||
############################################################################## | ||
|
||
# Attempt to set APP_HOME | ||
|
||
# Resolve links: $0 may be a link | ||
app_path=$0 | ||
|
||
# Need this for daisy-chained symlinks. | ||
while | ||
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path | ||
[ -h "$app_path" ] | ||
do | ||
ls=$( ls -ld "$app_path" ) | ||
link=${ls#*' -> '} | ||
case $link in #( | ||
/*) app_path=$link ;; #( | ||
*) app_path=$APP_HOME$link ;; | ||
esac | ||
done | ||
|
||
# This is normally unused | ||
# shellcheck disable=SC2034 | ||
APP_BASE_NAME=${0##*/} | ||
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) | ||
APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit | ||
|
||
# Use the maximum available, or set MAX_FD != -1 to use that value. | ||
MAX_FD=maximum | ||
|
||
warn () { | ||
echo "$*" | ||
} >&2 | ||
|
||
die () { | ||
echo | ||
echo "$*" | ||
echo | ||
exit 1 | ||
} >&2 | ||
|
||
# OS specific support (must be 'true' or 'false'). | ||
cygwin=false | ||
msys=false | ||
darwin=false | ||
nonstop=false | ||
case "$( uname )" in #( | ||
CYGWIN* ) cygwin=true ;; #( | ||
Darwin* ) darwin=true ;; #( | ||
MSYS* | MINGW* ) msys=true ;; #( | ||
NONSTOP* ) nonstop=true ;; | ||
esac | ||
|
||
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar | ||
|
||
|
||
# Determine the Java command to use to start the JVM. | ||
if [ -n "$JAVA_HOME" ] ; then | ||
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then | ||
# IBM's JDK on AIX uses strange locations for the executables | ||
JAVACMD=$JAVA_HOME/jre/sh/java | ||
else | ||
JAVACMD=$JAVA_HOME/bin/java | ||
fi | ||
if [ ! -x "$JAVACMD" ] ; then | ||
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME | ||
Please set the JAVA_HOME variable in your environment to match the | ||
location of your Java installation." | ||
fi | ||
else | ||
JAVACMD=java | ||
if ! command -v java >/dev/null 2>&1 | ||
then | ||
die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. | ||
Please set the JAVA_HOME variable in your environment to match the | ||
location of your Java installation." | ||
fi | ||
fi | ||
|
||
# Increase the maximum file descriptors if we can. | ||
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then | ||
case $MAX_FD in #( | ||
max*) | ||
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. | ||
# shellcheck disable=SC2039,SC3045 | ||
MAX_FD=$( ulimit -H -n ) || | ||
warn "Could not query maximum file descriptor limit" | ||
esac | ||
case $MAX_FD in #( | ||
'' | soft) :;; #( | ||
*) | ||
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. | ||
# shellcheck disable=SC2039,SC3045 | ||
ulimit -n "$MAX_FD" || | ||
warn "Could not set maximum file descriptor limit to $MAX_FD" | ||
esac | ||
fi | ||
|
||
# Collect all arguments for the java command, stacking in reverse order: | ||
# * args from the command line | ||
# * the main class name | ||
# * -classpath | ||
# * -D...appname settings | ||
# * --module-path (only if needed) | ||
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. | ||
|
||
# For Cygwin or MSYS, switch paths to Windows format before running java | ||
if "$cygwin" || "$msys" ; then | ||
APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) | ||
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) | ||
|
||
JAVACMD=$( cygpath --unix "$JAVACMD" ) | ||
|
||
# Now convert the arguments - kludge to limit ourselves to /bin/sh | ||
for arg do | ||
if | ||
case $arg in #( | ||
-*) false ;; # don't mess with options #( | ||
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath | ||
[ -e "$t" ] ;; #( | ||
*) false ;; | ||
esac | ||
then | ||
arg=$( cygpath --path --ignore --mixed "$arg" ) | ||
fi | ||
# Roll the args list around exactly as many times as the number of | ||
# args, so each arg winds up back in the position where it started, but | ||
# possibly modified. | ||
# | ||
# NB: a `for` loop captures its iteration list before it begins, so | ||
# changing the positional parameters here affects neither the number of | ||
# iterations, nor the values presented in `arg`. | ||
shift # remove old arg | ||
set -- "$@" "$arg" # push replacement arg | ||
done | ||
fi | ||
|
||
|
||
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. | ||
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' | ||
|
||
# Collect all arguments for the java command: | ||
# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, | ||
# and any embedded shellness will be escaped. | ||
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be | ||
# treated as '${Hostname}' itself on the command line. | ||
|
||
set -- \ | ||
"-Dorg.gradle.appname=$APP_BASE_NAME" \ | ||
-classpath "$CLASSPATH" \ | ||
org.gradle.wrapper.GradleWrapperMain \ | ||
"$@" | ||
|
||
# Stop when "xargs" is not available. | ||
if ! command -v xargs >/dev/null 2>&1 | ||
then | ||
die "xargs is not available" | ||
fi | ||
|
||
# Use "xargs" to parse quoted args. | ||
# | ||
# With -n1 it outputs one arg per line, with the quotes and backslashes removed. | ||
# | ||
# In Bash we could simply go: | ||
# | ||
# readarray ARGS < <( xargs -n1 <<<"$var" ) && | ||
# set -- "${ARGS[@]}" "$@" | ||
# | ||
# but POSIX shell has neither arrays nor command substitution, so instead we | ||
# post-process each arg (as a line of input to sed) to backslash-escape any | ||
# character that might be a shell metacharacter, then use eval to reverse | ||
# that process (while maintaining the separation between arguments), and wrap | ||
# the whole thing up as a single "set" statement. | ||
# | ||
# This will of course break if any of these variables contains a newline or | ||
# an unmatched quote. | ||
# | ||
|
||
eval "set -- $( | ||
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | | ||
xargs -n1 | | ||
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | | ||
tr '\n' ' ' | ||
)" '"$@"' | ||
|
||
exec "$JAVACMD" "$@" |
Oops, something went wrong.