Rocket.Chat.ReactNative/README.md

Rocket.Chat React Native Mobile

Supported Server Versions: 0.58.0+ (We are working to support earlier versions)

Download

Note: If you want to try iOS version, send us an email to testflight@rocket.chat and we'll add you to TestFlight users.

Installing dependencies

Follow the React Native Getting Started Guide for detailed instructions on setting up your local machine for development.

How to run

• Clone repository and install dependencies:

  $ git clone git@github.com:RocketChat/Rocket.Chat.ReactNative.git
  $ cd Rocket.Chat.ReactNative
  $ npm install -g react-native-cli
  $ npm install
  

• Configuration

  $ npm run fabric-ios --key="YOUR_API_KEY" --secret="YOUR_API_SECRET"
  $ npm run fabric-android --key="YOUR_API_KEY" --secret="YOUR_API_SECRET"
  

• Run application

  $ npm run ios
  

  $ npm run android
  

Running single server

If you don't need multiple servers, there is a branch single-server just for that.

Readme will guide you on how to config.

Detox (end-to-end tests)

• Build your app

$ detox build

• Run tests

$ detox test

Storybook

• General requirements

  • Install storybook

    $ npm i -g @storybook/cli
    

• Running storybook

  • Run storybook application

    $ npm run storybook
    

  • Run application in other shell

    $ react-native run-ios
    

  • Running storybook on browser to help stories navigation

    open http://localhost:7007/