# react-native-cbl

react-native-cbl is a React Native module providing an easy way to create offline-first, lightweight and performant mobile application on both iOS and Android platforms. This is an all-native wrapper over Couchbase Lite, which is a document-oriented database running right on the mobile devices.

## Getting started

`$ npm install react-native-cbl --save`

or

`$ yarn add react-native-cbl`

### Mostly automatic installation

`$ react-native link react-native-cbl`

### Manual installation


#### iOS

1. In XCode, in the project navigator, right click `Libraries` ➜ `Add Files to [your project's name]`
2. Go to `node_modules` ➜ `react-native-cbl` and add `RNReactNativeCbl.xcodeproj`
3. In XCode, in the project navigator, select your project. Add `libRNReactNativeCbl.a` to your project's `Build Phases` ➜ `Link Binary With Libraries`
4. Run your project (`Cmd+R`)<

#### Android

1. Open up `android/app/src/main/java/[...]/MainActivity.java`
  - Add `import com.reactlibrary.RNReactNativeCblPackage;` to the imports at the top of the file
  - Add `new RNReactNativeCblPackage()` to the list returned by the `getPackages()` method
2. Append the following lines to `android/settings.gradle`:
  	```
  	include ':react-native-cbl'
  	project(':react-native-cbl').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-cbl/android')
  	```
3. Insert the following lines inside the dependencies block in `android/app/build.gradle`:
  	```
      compile project(':react-native-cbl')
  	```

## Usage
```javascript
import CouchbaseLite, { CBLConnection, CBLConnector } from 'react-native-cbl'

const cblConnection = new CBLConnection({
  dbName: 'mydb',
  syncGatewayUrl: 'http://sg.myapp.com/mydb',
  views: { ... },
})

export default class App extends React.Component {
  onButtonClicked() {
    CouchbaseLite.createDocument({ title: 'New Title', text: 'Description' })
  }

  render() {
    return (
      <CBLConnector connection={cblConnection}>
        ...
      </CBLConnector>
    )
  }
}
```

## Demo App

There is a demo app available at https://github.com/bjornd/ReactNativeNotes