Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MyUNiDAYS/couchbaselite-kotlin-sdk
A Kotlin Multiplatform Wrapper of Couchbase
https://github.com/MyUNiDAYS/couchbaselite-kotlin-sdk
Last synced: 2 months ago
JSON representation
A Kotlin Multiplatform Wrapper of Couchbase
- Host: GitHub
- URL: https://github.com/MyUNiDAYS/couchbaselite-kotlin-sdk
- Owner: MyUNiDAYS
- License: mit
- Created: 2023-08-03T09:30:21.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-11-10T08:55:03.000Z (about 1 year ago)
- Last Synced: 2024-08-02T09:26:28.484Z (6 months ago)
- Language: Kotlin
- Size: 209 KB
- Stars: 10
- Watchers: 16
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-kotlin-multiplatform - Couchbaselite - Kotlin Multiplatform wrapper for the Couchbase Lite Mobile Database. (Libraries / Storage)
README
Couchbase Lite Kotlin SDK
A Kotlin Multiplatform wrapper for Couchbase Lite
## Installation
```
implementation("com.myunidays:couchbaselite:0.1.1")
```
## How to use
### KMM
The api is based on the android sdk, I would recommend you use https://docs.couchbase.com/couchbase-lite/current/android/quickstart.html as the main point of reference.
```kotlin
CouchbaseLite.init(context = context, logLevel= LogLevel.VERBOSE) //initialise for android use Context for ios use null or NSBundle
val database = Database(dbName)
val collection = database.createCollection(collName)
```
## Contributing
This project is set up as an open source project. As such, if there are any suggestions that you have for features, for improving the code itself, or you have come across any problems; you can raise them and/or suggest changes in implementation.
If you are interested in contributing to this codebase, please follow the contributing guidelines. This contains guides on both contributing directly and raising feature requests or bug reports. Please adhere to our code of conduct when doing any of the above.