61 lines
2.6 KiB
Markdown
61 lines
2.6 KiB
Markdown
# Rocket.Chat React Native Mobile
|
|
|
|
[![Greenkeeper badge](https://badges.greenkeeper.io/RocketChat/Rocket.Chat.ReactNative.svg)](https://greenkeeper.io/)
|
|
|
|
[![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)
|
|
[![codecov](https://codecov.io/gh/RocketChat/Rocket.Chat.ReactNative/branch/master/graph/badge.svg)](https://codecov.io/gh/RocketChat/Rocket.Chat.ReactNative)
|
|
[![CodeFactor](https://www.codefactor.io/repository/github/rocketchat/rocket.chat.reactnative/badge)](https://www.codefactor.io/repository/github/rocketchat/rocket.chat.reactnative)
|
|
[![Known Vulnerabilities](https://snyk.io/test/github/rocketchat/rocket.chat.reactnative/badge.svg)](https://snyk.io/test/github/rocketchat/rocket.chat.reactnative)
|
|
[![BCH compliance](https://bettercodehub.com/edge/badge/RocketChat/Rocket.Chat.ReactNative?branch=master)](https://bettercodehub.com/)
|
|
|
|
**Supported Server Versions:** 0.58.0+ (We are working to support earlier versions)
|
|
|
|
# Installing dependencies
|
|
|
|
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.
|
|
|
|
# How to run
|
|
- Clone repository and install dependencies:
|
|
```bash
|
|
$ git clone git@github.com:RocketChat/Rocket.Chat.ReactNative.git
|
|
$ cd Rocket.Chat.ReactNative
|
|
$ npm install -g react-native-cli
|
|
$ yarn
|
|
```
|
|
- Configuration
|
|
```bash
|
|
$ yarn fabric-ios --key="YOUR_API_KEY" --secret="YOUR_API_SECRET"
|
|
$ yarn fabric-android --key="YOUR_API_KEY" --secret="YOUR_API_SECRET"
|
|
```
|
|
|
|
- Run application
|
|
```bash
|
|
$ yarn ios
|
|
```
|
|
```bash
|
|
$ yarn android
|
|
```
|
|
|
|
# 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/
|
|
```
|