2017-08-16 17:44:26 +00:00
# Rocket.Chat React Native Mobile
2017-11-13 20:55:58 +00:00
[![Greenkeeper badge ](https://badges.greenkeeper.io/RocketChat/Rocket.Chat.ReactNative.svg )](https://greenkeeper.io/)
2017-08-18 14:50:20 +00:00
[![Build Status ](https://img.shields.io/travis/RocketChat/Rocket.Chat.ReactNative/master.svg )](https://travis-ci.org/RocketChat/Rocket.Chat.ReactNative)
[![Project Dependencies ](https://david-dm.org/RocketChat/Rocket.Chat.ReactNative.svg )](https://david-dm.org/RocketChat/Rocket.Chat.ReactNative)
[![Codacy Badge ](https://api.codacy.com/project/badge/Grade/bb15e2392a71473ea59d3f634f35c54e )](https://www.codacy.com/app/RocketChat/Rocket.Chat.ReactNative?utm_source=github.com& utm_medium=referral& utm_content=RocketChat/Rocket.Chat.ReactNative& utm_campaign=badger)
2017-08-18 15:50:48 +00:00
[![codecov ](https://codecov.io/gh/RocketChat/Rocket.Chat.ReactNative/branch/master/graph/badge.svg )](https://codecov.io/gh/RocketChat/Rocket.Chat.ReactNative)
2017-08-18 16:42:34 +00:00
[![CodeFactor ](https://www.codefactor.io/repository/github/rocketchat/rocket.chat.reactnative/badge )](https://www.codefactor.io/repository/github/rocketchat/rocket.chat.reactnative)
2017-08-18 16:56:39 +00:00
[![Known Vulnerabilities ](https://snyk.io/test/github/rocketchat/rocket.chat.reactnative/badge.svg )](https://snyk.io/test/github/rocketchat/rocket.chat.reactnative)
2017-08-18 17:04:36 +00:00
[![BCH compliance ](https://bettercodehub.com/edge/badge/RocketChat/Rocket.Chat.ReactNative?branch=master )](https://bettercodehub.com/)
2017-08-18 14:50:20 +00:00
2017-08-16 17:44:26 +00:00
**Supported Server Versions:** 0.58.0+ (We are working to support earlier versions)
2018-06-13 01:33:00 +00:00
# Download
[![Rocket.Chat.ReactNative on Google Play ](https://play.google.com/intl/en_us/badges/images/badge_new.png )](https://play.google.com/store/apps/details?id=chat.rocket.reactnative)
Note: If you want to try iOS version, send us an email to testflight@rocket.chat and we'll add you to TestFlight users.
2018-04-03 16:24:59 +00:00
# Installing dependencies
2017-08-16 17:44:26 +00:00
Follow the [React Native Getting Started Guide ](https://facebook.github.io/react-native/docs/getting-started.html ) for detailed instructions on setting up your local machine for development.
2018-04-03 16:24:59 +00:00
# How to run
- Clone repository and install dependencies:
2017-08-16 17:44:26 +00:00
```bash
$ git clone git@github.com:RocketChat/Rocket.Chat.ReactNative.git
$ cd Rocket.Chat.ReactNative
$ npm install -g react-native-cli
2018-04-24 19:34:03 +00:00
$ npm install
2018-04-03 16:24:59 +00:00
```
- Configuration
```bash
2018-04-24 19:34:03 +00:00
$ npm run fabric-ios --key="YOUR_API_KEY" --secret="YOUR_API_SECRET"
$ npm run fabric-android --key="YOUR_API_KEY" --secret="YOUR_API_SECRET"
2017-08-16 17:44:26 +00:00
```
- Run application
```bash
2018-04-24 19:34:03 +00:00
$ npm run ios
2017-08-16 17:44:26 +00:00
```
```bash
2018-04-24 19:34:03 +00:00
$ npm run android
2017-08-16 17:44:26 +00:00
```
2018-05-23 13:39:18 +00:00
# Detox (end-to-end tests)
- Build your app
```bash
$ detox build
```
- Run tests
```bash
$ detox test
```
2017-08-17 19:31:27 +00:00
# Storybook
- General requirements
- Install storybook
```bash
$ npm i -g @storybook/cli
```
- Running storybook
- Run storybook application
```bash
$ npm run storybook
```
- Run application in other shell
```bash
$ react-native run-ios
```
- Running storybook on browser to help stories navigation
```
open http://localhost:7007/
```