> For the complete documentation index, see [llms.txt](https://dormakaba-digital.gitbook.io/reactnative-client/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dormakaba-digital.gitbook.io/reactnative-client/getting-started.md).

# Getting started

This is the documentation for the react-native module used by dormakaba digital to build react-native apps based on the visual components provided in [@dormakaba/digital-reactnative-visual](https://dormakaba-digital.gitbook.io/reactnative-visual).

The repository can be found here: <https://github.com/dormakaba-digital/digital-reactnative-client>

### Installation

The module is provided as an npm module:

```bash
npm install @dormakaba/digital-reactnative-client --save
```

Install and link the peer dependencies

```bash
# install dependencies
npm i @dormakaba/digital-reactnative-visual --save
npm i moment --save
npm i react-native-device-info --save
npm i react-navigation --save

# link
node node_modules/react-native/local-cli/cli.js link
```

{% hint style="warning" %}
As this module depends on our visual components please also make sure to read and follow the instructions [there](https://dormakaba-digital.gitbook.io/reactnative-visual/getting-started).
{% endhint %}

### Using the components

All components and utils are provided as named exports

```javascript
import { Drawer, NavButton, Navigator } from '@dormakaba/digital-reactnative-client'
```