Mobile App Environment Setup
The Rocket.Chat mobile app is developed with React Native, helping us create both Android and iOS applications from a single codebase.
Setting up the development environment requires you to download and install multiple dependencies. You will need an active internet connection throughout the process.

Requirements

You are required to have the following installed already on your machine before starting. If you don't, please take a minute and get them ready.
  • Git
  • Node.js
  • Yarn is recommended instead of npm.
  • MacOS with XCode Command Line Tools is needed to run iOS version
  • Android Studio is needed to run the Android version
Additionally, refer to React Native environment setup to make sure everything is up and running. Follow the React Native CLI Quickstart section as we don't support Expo managed flow.

Get the Code

How to run

Clone repository and install dependencies:
1
git clone [email protected]:RocketChat/Rocket.Chat.ReactNative.git
2
cd Rocket.Chat.ReactNative
3
yarn
Copied!
Run the app:
1
npx pod-install
2
yarn ios
Copied!
or
1
yarn android
Copied!
At this point, the app should be running on the simulator or on your device!
Note: npm won't work on this project

Contributing

Issues needing help

Didn't find a bug or want a new feature not already reported? Check out the help wanted or the good first issue labels.
Can't help coding? Triaging issues is a great way of helping.

Pull request

As soon as your changes are ready, you can open a Pull Request.
The title of your PR should be descriptive, including either [NEW], [IMPROVEMENT] or [FIX] at the beginning, e.g. [FIX] App crashing on startup.
You may share working results prior to finishing, please include [WIP] in the title. This way anyone can look at your code: you can ask for help within the PR if you don't know how to solve a problem.
Your PR is automatically inspected by various tools, check their response and try to improve your code accordingly. Requests that fail to build or have wrong coding style won't be merged.
Last modified 2mo ago