docs

Zulip Mobile developer documentation

This directory contains documentation for contributing to the Zulip mobile app, for iOS and Android.

Getting the app

See the main README.

Contributing

If you're interested in helping out with Zulip, please install the beta app and report bugs :-).

To get started with the code, follow our Developer Guide.

Then see our Contribution Guidelines, and come say hello in the #mobile stream.

To learn more, take a look through our developer documentation. See below.

Documentation overview

The key docs to read up front are the main README, the Developer Guide, and the Contribution Guidelines.

After you've gotten the development environment running, and said hello in the #mobile stream in chat, some good things to read to learn more include:

• Architecture
• Glossary
• Testing
• our Git Guide (and try out all the example commands)
• Debugging (linked from the Developer Guide, but worth rereading after you've done a PR or two)
• Recommended Reading
• WebView-specific
• ... and browse through this whole docs/ subtree to see what else is here. ;-)

Searching the documentation

To search through the documentation, you can use the search feature here on GitHub. Here's an example search for "redux"; start from there and replace "redux" with whatever you'd like to search for.

Alternatively, search the docs inside your own clone of the repo. Try a command like one of these:

$ git grep -C2 -i redux docs/

$ rg -C2 -i redux docs/

(For extra search features, see docs: git grep, rg.) Or use your favorite alternate search tool, or a search in your IDE.