verdnatura-mirror/Rocket.Chat.ReactNative
verdnatura-mirror
/
Rocket.Chat.ReactNative
mirror of https://github.com/RocketChat/Rocket.Chat.ReactNative
2
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity
Rocket.Chat.ReactNative/README.md

240 lines
13 KiB
Markdown
Raw Normal View History

[DOCS] Update readme (#1459)
2019-12-11 20:02:15 +00:00
# Rocket.Chat Mobile
Create README.md
2017-08-16 17:44:26 +00:00
Ci (#25) * Init travis configuration * Try travis * Try travis * Try travis * Try travis * Try travis * Try Travis * Fiz name and add badges
2017-08-18 14:50:20 +00:00
[![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)
Code Coverage (#26) * Init travis configuration * Try travis * Try travis * Try travis * Try travis * Try travis * Try Travis * Fiz name and add badges * Start code cov * Configure codecov * Add codecov * Add badge
2017-08-18 15:50:48 +00:00
[![codecov](https://codecov.io/gh/RocketChat/Rocket.Chat.ReactNative/branch/master/graph/badge.svg)](https://codecov.io/gh/RocketChat/Rocket.Chat.ReactNative)
Add Codefactor badge (#27)
2017-08-18 16:42:34 +00:00
[![CodeFactor](https://www.codefactor.io/repository/github/rocketchat/rocket.chat.reactnative/badge)](https://www.codefactor.io/repository/github/rocketchat/rocket.chat.reactnative)
Ci (#25) * Init travis configuration * Try travis * Try travis * Try travis * Try travis * Try travis * Try Travis * Fiz name and add badges
2017-08-18 14:50:20 +00:00
[CHORE] Update README (#1081)
2019-07-29 18:26:35 +00:00
**Supported Server Versions:** 0.70.0+
Unnecessary re-renders removed (#570) * shouldComponentUpdate * Rooms list shouldcomponentupdate * RoomView shouldComponentUpdate * Messagebox and Message shouldComponentUpdate * EmojiPicker shouldComponentUpdate * RoomActions shouldComponentUpdate * Room info shouldComponentUpdate * Update RNN * Use only one Flatlist if none group filter is selected * Update fix * shouldComponentUpdate * Bug fixes * ListView changes * Bug fix * render list bug fix * Changes on public channels * - RoomView saga leak removed - Join room e2e tests added * Rest versions * Method call versions * Min RocketChat version alert
2018-12-21 10:55:35 +00:00
Add roadmap (#406) <!-- INSTRUCTION: Keep the line below to notify all core developers about this new PR --> @RocketChat/ReactNative <!-- INSTRUCTION: Inform the issue number that this PR closes, or remove the line below --> Closes #45 <!-- INSTRUCTION: Tell us more about your PR with screen shots if you can -->
2018-08-10 13:18:35 +00:00
## Download
[DOCS] Update readme (#1459)
2019-12-11 20:02:15 +00:00
### Official apps
<a href="https://play.google.com/store/apps/details?id=chat.rocket.android">
<img alt="Download on Google Play" src="https://play.google.com/intl/en_us/badges/images/badge_new.png" height=43>
</a>
<a href="https://apps.apple.com/us/app/rocket-chat/id1148741252">
<img alt="Download on App Store" src="https://user-images.githubusercontent.com/7317008/43209852-4ca39622-904b-11e8-8ce1-cdc3aee76ae9.png" height=43>
</a>
### Experimental apps
Bump version to 1.6.0 (#543)
2018-11-19 19:01:10 +00:00
<a href="https://play.google.com/store/apps/details?id=chat.rocket.reactnative">
<img alt="Download on Google Play" src="https://play.google.com/intl/en_us/badges/images/badge_new.png" height=43>
</a>
<a href="https://itunes.apple.com/us/app/rocket-chat-experimental/id1272915472">
<img alt="Download on App Store" src="https://user-images.githubusercontent.com/7317008/43209852-4ca39622-904b-11e8-8ce1-cdc3aee76ae9.png" height=43>
</a>
[NEW] User Profile (#323) * Drawer layout * Drawer changes * Profile * Profile avatar * Set language * Tests * Custom fields * Readme updated * fix invalid user muted value * Fix for "Cannot add a child that doesn't have a YogaNode to a parent without a measure function! (Trying to add a 'RCTVirtualText' to a 'RCTView')"
2018-06-13 01:33:00 +00:00
[CHORE] Add TestFlight invite and update Readme (#623)
2019-02-12 18:02:23 +00:00
## Beta Access
### TestFlight
[DOCS] Update readme (#1459)
2019-12-11 20:02:15 +00:00
You can signup to our TestFlight builds by accessing these links:
- Official: https://testflight.apple.com/join/3gcYeoMr
- Experimental: https://testflight.apple.com/join/7I3dLCNT.
[CHORE] Add TestFlight invite and update Readme (#623)
2019-02-12 18:02:23 +00:00
Update readme (#714)
2019-03-13 20:58:47 +00:00
### Google Play beta
[CHORE] Add TestFlight invite and update Readme (#623)
2019-02-12 18:02:23 +00:00
[DOCS] Update readme (#1459)
2019-12-11 20:02:15 +00:00
You can subscribe to Google Play Beta program and download latest versions:
- Official: https://play.google.com/store/apps/details?id=chat.rocket.android
- Experimental: https://play.google.com/store/apps/details?id=chat.rocket.reactnative
[CHORE] Add TestFlight invite and update Readme (#623)
2019-02-12 18:02:23 +00:00
## Reporting an Issue
[Github Issues](https://github.com/RocketChat/Rocket.Chat.ReactNative/issues) are used to track todos, bugs, feature requests, and more.
Update readme (#714)
2019-03-13 20:58:47 +00:00
Also check the [#react-native](https://open.rocket.chat/channel/react-native) community on [open.rocket.chat](https://open.rocket.chat). We'd like to help.
[CHORE] Add TestFlight invite and update Readme (#623)
2019-02-12 18:02:23 +00:00
Add roadmap (#406) <!-- INSTRUCTION: Keep the line below to notify all core developers about this new PR --> @RocketChat/ReactNative <!-- INSTRUCTION: Inform the issue number that this PR closes, or remove the line below --> Closes #45 <!-- INSTRUCTION: Tell us more about your PR with screen shots if you can -->
2018-08-10 13:18:35 +00:00
## Installing dependencies
Create README.md
2017-08-16 17:44:26 +00:00
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.
Add roadmap (#406) <!-- INSTRUCTION: Keep the line below to notify all core developers about this new PR --> @RocketChat/ReactNative <!-- INSTRUCTION: Inform the issue number that this PR closes, or remove the line below --> Closes #45 <!-- INSTRUCTION: Tell us more about your PR with screen shots if you can -->
2018-08-10 13:18:35 +00:00
## How to run
Crashlytics (#258) * Fabric iOS * Fabric configured on iOS and Android * login tracked * more logs * fix reaction
2018-04-03 16:24:59 +00:00
- Clone repository and install dependencies:
Create README.md
2017-08-16 17:44:26 +00:00
```bash
$ git clone git@github.com:RocketChat/Rocket.Chat.ReactNative.git
$ cd Rocket.Chat.ReactNative
Update JS SDK version (#602)
2019-02-07 15:48:10 +00:00
$ yarn
Crashlytics (#258) * Fabric iOS * Fabric configured on iOS and Android * login tracked * more logs * fix reaction
2018-04-03 16:24:59 +00:00
```
Create README.md
2017-08-16 17:44:26 +00:00
- Run application
```bash
[FIX] Remove react-native global installs (#1886) Co-authored-by: Diego Mello <diegolmello@gmail.com>
2020-03-17 20:36:13 +00:00
$ npx react-native run-ios
Create README.md
2017-08-16 17:44:26 +00:00
```
```bash
[FIX] Remove react-native global installs (#1886) Co-authored-by: Diego Mello <diegolmello@gmail.com>
2020-03-17 20:36:13 +00:00
$ npx react-native run-android
Create README.md
2017-08-16 17:44:26 +00:00
```
[DOCS] Add Whitelabel (#2379)
2020-08-07 12:32:47 +00:00
### Whitelabel
Follow our docs: https://docs.rocket.chat/guides/developer/mobile-apps/whitelabeling-mobile-apps
Added single-server to readme (#390) <!-- INSTRUCTION: Keep the line below to notify all core developers about this new PR --> @RocketChat/ReactNative <!-- INSTRUCTION: Inform the issue number that this PR closes, or remove the line below --> Closes #386 Closes #295 <!-- INSTRUCTION: Tell us more about your PR with screen shots if you can -->
2018-07-30 13:56:42 +00:00
Update readme (#714)
2019-03-13 20:58:47 +00:00
## Current priorities
[DOCS] Update readme (#1459)
2019-12-11 20:02:15 +00:00
1) Omnichannel support
2) E2E encryption
Add roadmap (#406) <!-- INSTRUCTION: Keep the line below to notify all core developers about this new PR --> @RocketChat/ReactNative <!-- INSTRUCTION: Inform the issue number that this PR closes, or remove the line below --> Closes #45 <!-- INSTRUCTION: Tell us more about your PR with screen shots if you can -->
2018-08-10 13:18:35 +00:00
## Features
Update readme (#714)
2019-03-13 20:58:47 +00:00
| Feature | Status |
|--------------------------------------------------------------- |-------- |
[DOCS] Update Readme (#1346)
2019-10-31 16:23:00 +00:00
| Jitsi Integration | ✅ |
[CHORE] Update README (#1081)
2019-07-29 18:26:35 +00:00
| Federation (Directory) | ✅ |
[NEW] Create discussions (#1942) * [WIP][NEW] Create Discussion * [FIX] Clear multiselect & Translations * [NEW] Create Discussion at MessageActions * [NEW] Disabled Multiselect * [FIX] Initial channel * [NEW] Create discussion on MessageBox Actions * [FIX] Crashing on edit name * [IMPROVEMENT] New message layout * [CHORE] Update README * [NEW] Avatars on MultiSelect * [FIX] Select Users * [FIX] Add redirect and Handle tablet * [IMPROVEMENT] Split CreateDiscussionView * [FIX] Create a discussion inner discussion * [FIX] Create a discussion * [I18N] Add pt-br * Change icons * [FIX] Nav to discussion & header title * Fix header Co-authored-by: Diego Mello <diegolmello@gmail.com>
2020-03-30 19:50:27 +00:00
| Discussions | ✅ |
[DOCS] Update readme (#1459)
2019-12-11 20:02:15 +00:00
| Omnichannel | ❌ |
[CHORE] Update README (#1081)
2019-07-29 18:26:35 +00:00
| Threads | ✅ |
Update readme (#714)
2019-03-13 20:58:47 +00:00
| Record Audio | ✅ |
[CHORE] Update README (#1081)
2019-07-29 18:26:35 +00:00
| Record Video | ✅ |
| Commands | ✅ |
[CHORE] Update readme (#885)
2019-05-23 12:06:15 +00:00
| Draft message per room | ✅ |
[CHORE] Update README (#1081)
2019-07-29 18:26:35 +00:00
| Share Extension | ✅ |
Update readme (#714)
2019-03-13 20:58:47 +00:00
| Notifications Preferences | ✅ |
| Edited status | ✅ |
[CHORE] Update README (#1081)
2019-07-29 18:26:35 +00:00
| Upload video | ✅ |
Update readme (#714)
2019-03-13 20:58:47 +00:00
| Grouped messages | ✅ |
[CHORE] Update README (#1081)
2019-07-29 18:26:35 +00:00
| Mark room as read | ✅ |
| Mark room as unread | ✅ |
[DOCS] Update readme (#1459)
2019-12-11 20:02:15 +00:00
| Tablet Support | ✅ |
[CHORE] Update README (#1081)
2019-07-29 18:26:35 +00:00
| Read receipt | ✅ |
Update readme (#714)
2019-03-13 20:58:47 +00:00
| Broadbast Channel | ✅ |
[DOCS] Update README.md (#1134)
2019-08-19 19:44:19 +00:00
| Authentication via SAML | ✅ |
| Authentication via CAS | ✅ |
[CHORE] Update README (#1081)
2019-07-29 18:26:35 +00:00
| Custom Fields on Signup | ✅ |
| Report message | ✅ |
[DOCS] Update readme (#1459)
2019-12-11 20:02:15 +00:00
| Theming | ✅ |
[NEW] Request review (#1627)
2020-02-03 18:28:18 +00:00
| Settings -> Review the App | ✅ |
[NEW] Default browser (#1752) Co-authored-by: Diego Mello <diegolmello@gmail.com>
2020-02-19 20:52:05 +00:00
| Settings -> Default Browser | ✅ |
[CHORE] Update readme (#885)
2019-05-23 12:06:15 +00:00
| Admin panel | ✅ |
[DOCS] Update Readme (#1485)
2019-12-19 13:07:53 +00:00
| Reply message from notification | ✅ |
Update readme (#714)
2019-03-13 20:58:47 +00:00
| Unread counter banner on message list | ✅ |
[CHORE] Update README (#1081)
2019-07-29 18:26:35 +00:00
| E2E Encryption | ❌ |
Update readme (#714)
2019-03-13 20:58:47 +00:00
| Join a Protected Room | ❌ |
[DOCS] Update Readme (#1346)
2019-10-31 16:23:00 +00:00
| Optional Analytics | ✅ |
Update readme (#714)
2019-03-13 20:58:47 +00:00
| Settings -> About us | ❌ |
[CHORE] Update README (#1081)
2019-07-29 18:26:35 +00:00
| Settings -> Contact us | ✅ |
Update readme (#714)
2019-03-13 20:58:47 +00:00
| Settings -> Update App Icon | ❌ |
[DOCS] Update Readme (#1346)
2019-10-31 16:23:00 +00:00
| Settings -> Share | ✅ |
Update readme (#714)
2019-03-13 20:58:47 +00:00
| Accessibility (Medium) | ❌ |
| Accessibility (Advanced) | ❌ |
| Authentication via Meteor | ❌ |
[NEW] Wordpress auth (#1633)
2020-01-29 12:30:59 +00:00
| Authentication via Wordpress | ✅ |
[DOCS] Update README.md (#1134)
2019-08-19 19:44:19 +00:00
| Authentication via Custom OAuth | ✅ |
Update readme (#714)
2019-03-13 20:58:47 +00:00
| Add user to the room | ✅ |
| Send message | ✅ |
| Authentication via Email | ✅ |
| Authentication via Username | ✅ |
| Authentication via LDAP | ✅ |
| Message format: Markdown | ✅ |
| Message format: System messages (Welcome, Message removed...) | ✅ |
| Message format: links | ✅ |
| Message format: images | ✅ |
| Message format: replies | ✅ |
| Message format: alias with custom message (title & text) | ✅ |
| Messages list: day separation | ✅ |
| Messages list: load more on scroll | ✅ |
| Messages list: receive new messages via subscription | ✅ |
| Subscriptions list | ✅ |
| Segmented subscriptions list: Favorites | ✅ |
| Segmented subscriptions list: Unreads | ✅ |
| Segmented subscriptions list: DMs | ✅ |
| Segmented subscriptions list: Channels | ✅ |
| Subscriptions list: update user status via subscription | ✅ |
| Numbers os messages unread in the Subscriptions list | ✅ |
| Status change | ✅ |
| Upload image | ✅ |
| Take picture & upload it | ✅ |
| 2FA | ✅ |
| Signup | ✅ |
| Autocomplete with usernames | ✅ |
| Autocomplete with @all & @here | ✅ |
| Autocomplete room/channel name | ✅ |
| Upload audio | ✅ |
| Forgot your password | ✅ |
| Login screen: terms of service | ✅ |
| Login screen: privacy policy | ✅ |
| Authentication via Google | ✅ |
| Authentication via Facebook | ✅ |
| Authentication via Twitter | ✅ |
| Authentication via GitHub | ✅ |
| Authentication via GitLab | ✅ |
| Authentication via LinkedIn | ✅ |
| Create channel | ✅ |
| Search Local | ✅ |
| Search in the API | ✅ |
| Settings -> License | ✅ |
| Settings -> App version | ✅ |
| Autocomplete emoji | ✅ |
| Upload file (documents, PDFs, spreadsheets, zip files, etc) | ✅ |
| Copy message | ✅ |
| Pin message | ✅ |
| Unpin message | ✅ |
| Channel Info screen -> Members | ✅ |
| Channel Info screen -> Pinned | ✅ |
| Channel Info screen -> Starred | ✅ |
| Channel Info screen -> Uploads | ✅ |
| Star message | ✅ |
| Unstar message | ✅ |
| Channel Info screen -> Topic | ✅ |
| Channel Info screen -> Description | ✅ |
| Star a channel | ✅ |
| Message format: videos | ✅ |
| Message format: audios | ✅ |
| Edit message | ✅ |
| Delete a message | ✅ |
| Reply message | ✅ |
| Quote message | ✅ |
| Muted state | ✅ |
| Offline reading | ✅ |
| Offline writing | ✅ |
| Edit profile | ✅ |
| Reactions | ✅ |
| Custom emojis | ✅ |
| Accessibility (Basic) | ✅ |
| Tap notification, go to the channel | ✅ |
| Deep links: Authentication | ✅ |
| Deep links: Rooms | ✅ |
| Full name setting | ✅ |
| Read only rooms | ✅ |
| Typing status | ✅ |
| Create channel/group | ✅ |
| Disable registration setting | ✅ |
| Unread red line indicator on message list | ✅ |
| Search Messages in Channel | ✅ |
| Mentions List | ✅ |
| Attachment List | ✅ |
| Join a Room | ✅ |
Add roadmap (#406) <!-- INSTRUCTION: Keep the line below to notify all core developers about this new PR --> @RocketChat/ReactNative <!-- INSTRUCTION: Inform the issue number that this PR closes, or remove the line below --> Closes #45 <!-- INSTRUCTION: Tell us more about your PR with screen shots if you can -->
2018-08-10 13:18:35 +00:00
## Detox (end-to-end tests)
Detox tests E2E (#283)
2018-05-23 13:39:18 +00:00
- Build your app
```bash
[TESTS] Update and separate E2E tests (#2126) * Tests passing until roomslist * create room * roominfo * change server * broadcast * profile * custom status * forgot password * working * room and onboarding * Tests separated * config.yml refactor * Revert "config.yml refactor" This reverts commit 0e984d3029e47612726bf199553f7abdf24843e5. * CI * lint * CI refactor * Onboarding tests * npx detox * Add all tests * Save brew cache * mac-env executor * detox-test command * Update readme * Remove folder
2020-05-20 16:33:40 +00:00
$ npx detox build --configuration ios.sim.release
Detox tests E2E (#283)
2018-05-23 13:39:18 +00:00
```
- Run tests
```bash
[TESTS] Update and separate E2E tests (#2126) * Tests passing until roomslist * create room * roominfo * change server * broadcast * profile * custom status * forgot password * working * room and onboarding * Tests separated * config.yml refactor * Revert "config.yml refactor" This reverts commit 0e984d3029e47612726bf199553f7abdf24843e5. * CI * lint * CI refactor * Onboarding tests * npx detox * Add all tests * Save brew cache * mac-env executor * detox-test command * Update readme * Remove folder
2020-05-20 16:33:40 +00:00
$ npx detox test ./e2e/tests/onboarding --configuration ios.sim.release
$ npx detox test ./e2e/tests/room --configuration ios.sim.release
$ npx detox test ./e2e/tests/assorted --configuration ios.sim.release
[CHORE] Added Storybook documentation (#757)
2019-03-25 20:55:50 +00:00
```
## Storybook
- Open index.js
- Uncomment following line
```bash
import './storybook';
```
- Comment out following lines
```bash
import './app/ReactotronConfig';
import { AppRegistry } from 'react-native';
import App from './app/index';
import { name as appName } from './app.json';
AppRegistry.registerComponent(appName, () => App);
```
- Start your application again