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.
  • Git
  • Node.js
  • Yarn (recommended instead of npm)
  • macOS with XCode Command Line Tools is needed to run the iOS version
  • Android Studio is needed to run the Android version
Additionally, refer to React Native environment set up 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:
git clone [email protected]:RocketChat/Rocket.Chat.ReactNative.git
cd Rocket.Chat.ReactNative
yarn
Run the app:
npx pod-install
yarn ios
or
yarn android
At this point, the app should be running on the simulator or on your device!
npm won't work on this project.

Contributing

Issues needing help

If you didn't find a bug or want a new feature not already reported check out the help wanted or the good first issue labels.
Or if you 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 the wrong coding style won't be merged.
Export as PDF
Copy link
Edit on GitHub
On this page
Requirements
Get the Code
How to run
Contributing
Issues needing help
Pull request