Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/couchbase/couchbase-lite-ios
Lightweight, embedded, syncable NoSQL database engine for iOS and MacOS apps.
https://github.com/couchbase/couchbase-lite-ios
database ios macos mobile nosql objective-c swift sync
Last synced: 3 days ago
JSON representation
Lightweight, embedded, syncable NoSQL database engine for iOS and MacOS apps.
- Host: GitHub
- URL: https://github.com/couchbase/couchbase-lite-ios
- Owner: couchbase
- License: apache-2.0
- Created: 2013-02-01T00:09:26.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2025-01-10T23:02:55.000Z (15 days ago)
- Last Synced: 2025-01-16T00:32:02.792Z (10 days ago)
- Topics: database, ios, macos, mobile, nosql, objective-c, swift, sync
- Language: Objective-C
- Homepage:
- Size: 64.4 MB
- Stars: 1,627
- Watchers: 84
- Forks: 298
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - couchbase-lite-ios - Lightweight, embedded, syncable NoSQL database engine for iOS and MacOS apps. (sync)
- awesome - couchbase-lite-ios - Lightweight, embedded, syncable NoSQL database engine for iOS and MacOS apps. (sync)
README
# Couchbase Lite for iOS and MacOS
[](https://opensource.org/licenses/Apache-2.0) [](https://travis-ci.org/couchbase/couchbase-lite-ios) [](https://coveralls.io/github/couchbase/couchbase-lite-ios?branch=master)
**Couchbase Lite** is an embedded lightweight, document-oriented (NoSQL), syncable database engine.
Couchbase Lite implementation is on top of [Couchbase Lite Core](https://github.com/couchbase/couchbase-lite-core), which is also a new cross-platform implementation of database CRUD and query features, as well as document versioning.
## Requirements
- iOS 12.0+ | macOS 12+
- iOS 12.0+ | macOS 12.0+
## Installation
### Swift Package
#### Requirements:
- XCode 12+
##### Community Edition
```
dependencies: [
.package(name: "CouchbaseLiteSwift",
url: "https://github.com/couchbase/couchbase-lite-ios.git",
from: "3.2.0"),
],
```
##### Enterprise Edition
```
dependencies: [
.package(name: "CouchbaseLiteSwift",
url: "https://github.com/couchbase/couchbase-lite-swift-ee.git",
from: "3.2.0"),
],
```
More detailed information on how to setup is available here: [swift package manager](https://docs.couchbase.com/couchbase-lite/current/swift/start/swift-gs-install.html)
### CocoaPods
You can use [CocoaPods](https://cocoapods.org/) to install `CouchbaseLite` for Objective-C API or `CouchbaseLiteSwift` for Swift API by adding it in your [Podfile](https://guides.cocoapods.org/using/the-podfile.html):
#### Objective-C
##### Community Edition
```
target '' do
use_frameworks!
pod 'CouchbaseLite'
end
```
##### Enterprise Edition
```
target '' do
use_frameworks!
pod 'CouchbaseLite-Enterprise'
end
```
#### Swift
##### Community Edition
```
target '' do
use_frameworks!
pod 'CouchbaseLite-Swift'
end
```
##### Enterprise Edition
```
target '' do
use_frameworks!
pod 'CouchbaseLite-Swift-Enterprise'
end
```
### Carthage
You can use [Carthage](https://github.com/Carthage/Carthage) to install `CouchbaseLite` by adding it in your [Cartfile](https://github.com/Carthage/Carthage/blob/master/Documentation/Artifacts.md#cartfile):
##### Community Edition
```
binary "https://packages.couchbase.com/releases/couchbase-lite-ios/carthage/CouchbaseLite-Community.json"
```
##### Enterprise Edition
```
binary "https://packages.couchbase.com/releases/couchbase-lite-ios/carthage/CouchbaseLite-Enterprise.json"
```
> When running `carthage update or build`, Carthage will build both CouchbaseLite and CouchbaseLiteSwift framework.
## How to build the framework files.
1. Clone the repo and update submodules
```
$ git clone https://github.com/couchbase/couchbase-lite-ios.git
$ cd couchbase-lite-ios
$ git submodule update --init --recursive
```
2. If not already installed, install _doxygen_, `brew install doxygen`
3. Run ./Scripts/build_framework.sh to build a platform framework which could be either an Objective-C or a Swift framework. The supported platforms include iOS, tvOS, and macOS.
```
$ ./Scripts/build_framework.sh -s "CBL ObjC" -p iOS -o output // For building the ObjC framework for iOS
$ ./Scripts/build_framework.sh -s "CBL Swift" -p iOS -o output // For building the Swift framework for iOS
```
## Documentation
- [Swift](https://docs.couchbase.com/couchbase-lite/current/swift/quickstart.html)
- [Objective-C](https://docs.couchbase.com/couchbase-lite/current/objc/quickstart.html)
## Sample Apps
- [Todo](https://github.com/couchbaselabs/mobile-training-todo) : Objective-C and Swift
## License
Like all Couchbase source code, this is released under the Apache 2 [license](LICENSE).