sergiodt
/
vn-verdnaturachat
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme (#714)

This commit is contained in:
Diego Mello 2019-03-13 17:58:47 -03:00 committed by GitHub
parent 38dabfc9ff
commit 6be7f28baa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 145 additions and 159 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

304
README.md
View File

@ -6,7 +6,6 @@
[![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) [![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)
[![codecov](https://codecov.io/gh/RocketChat/Rocket.Chat.ReactNative/branch/master/graph/badge.svg)](https://codecov.io/gh/RocketChat/Rocket.Chat.ReactNative) [![codecov](https://codecov.io/gh/RocketChat/Rocket.Chat.ReactNative/branch/master/graph/badge.svg)](https://codecov.io/gh/RocketChat/Rocket.Chat.ReactNative)
[![CodeFactor](https://www.codefactor.io/repository/github/rocketchat/rocket.chat.reactnative/badge)](https://www.codefactor.io/repository/github/rocketchat/rocket.chat.reactnative) [![CodeFactor](https://www.codefactor.io/repository/github/rocketchat/rocket.chat.reactnative/badge)](https://www.codefactor.io/repository/github/rocketchat/rocket.chat.reactnative)
[![Known Vulnerabilities](https://snyk.io/test/github/rocketchat/rocket.chat.reactnative/badge.svg)](https://snyk.io/test/github/rocketchat/rocket.chat.reactnative)
**Supported Server Versions:** 0.66.0+ **Supported Server Versions:** 0.66.0+
@ -24,15 +23,15 @@
You can signup to our TestFlight builds by acessing this link: https://testflight.apple.com/join/7I3dLCNT. You can signup to our TestFlight builds by acessing this link: https://testflight.apple.com/join/7I3dLCNT.
### Android ### Google Play beta
You can get the latest Android builds at [#react-native](https://open.rocket.chat/channel/react-native) channel. You can subscribe to Google Play Beta program and download latest versions: https://play.google.com/store/apps/details?id=chat.rocket.reactnative
## Reporting an Issue ## Reporting an Issue
[Github Issues](https://github.com/RocketChat/Rocket.Chat.ReactNative/issues) are used to track todos, bugs, feature requests, and more. [Github Issues](https://github.com/RocketChat/Rocket.Chat.ReactNative/issues) are used to track todos, bugs, feature requests, and more.
Also check the community on [open.rocket.chat](https://open.rocket.chat/channel/react-native). We'd like to help. 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.
## Installing dependencies ## Installing dependencies
@ -49,182 +48,169 @@ Follow the [React Native Getting Started Guide](https://facebook.github.io/react
- Run application - Run application
```bash ```bash
$ yarn ios $ react-native run-ios
``` ```
```bash ```bash
$ yarn android $ react-native run-android
``` ```
### Running single server ### Running single server
If you don't need multiple servers, there is a branch `single-server` just for that. If you don't need multiple servers, there is a branch `single-server` just for that.
Readme will guide you on how to config. Readme will guide you on how to config.
## Roadmap ## Current priorities
1) [NEW] Jitsi integration ([#711][i711])
2) [NEW] Federation ([#706][i706])
3) [NEW] Threads ([#707][i707])
4) [NEW] Record video ([#712][i712])
5) [NEW] Slash Commands ([#405][i405])
6) [NEW] Draft message per room ([#708][i708])
7) [NEW] Share extension ([#391][i391])
### Current priorities [i711]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/711
1) [NEW] Jitsi integration [i706]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/706
2) [NEW] Slash Commands ([#405][i405]) [i707]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/707
3) [NEW] Read receipt ([#542][i542]) [i712]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/712
4) [Android] Group notifications by room ([#391][i391]) [i708]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/708
### To do
| Task | Status |
|--------------------|-----|
| [NEW] Jitsi integration | WIP | |
| [NEW] Settings layout ([#396][i396]) | ❌ |
| [NEW] Contextual bar layout ([#402][i402]) | ❌ |
| [NEW] Slash Commands ([#405][i405]) | ❌ |
| [Android] Group notifications by room ([#391][i391]) | ❌ |
| Custom icons ([#210][i210]) | ❌ |
| Share Extension ([#69][i69]) | ❌ |
| Upload files ([#2][i2]) | ❌ |
[i2]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/2
[i38]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/38
[i69]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/69
[i210]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/210
[i233]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/233
[i329]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/329
[i341]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/341
[i391]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/391 [i391]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/391
[i393]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/393
[i403]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/403
[i404]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/404
[i405]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/405 [i405]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/405
[i395]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/395
[i396]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/396
[i397]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/397
[i398]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/398
[i399]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/399
[i400]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/400
[i401]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/401
[i402]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/402
[i392]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/392
[i368]: https://github.com/RocketChat/Rocket.Chat.ReactNative/pull/368
[i311]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/311
[i542]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/542
## Features ## Features
| Feature | Status | | Feature | Status |
|----------------------------------------------------------------- |---------------- | |--------------------------------------------------------------- |-------- |
| Send message | ✅ | | Jitsi Integration | ❌ |
| Authentication via Email | ✅ | | Federation (Directory) | ❌ |
| Authentication via Username | ✅ | | Threads | ❌ |
| Authentication via LDAP | ✅ | | Record Audio | ✅ |
| Message format: Markdown | ✅ | | Record Video | ❌ |
| Message format: System messages (Welcome, Message removed...) | ✅ | | Commands | ❌ |
| Message format: links | ✅ | | Draft message per room | ❌ |
| Message format: images | ✅ | | Share Extension | ❌ |
| Message format: replies | ✅ | | Notifications Preferences | ✅ |
| Message format: alias with custom message (title & text) | ✅ | | Edited status | ✅ |
| Messages list: day separation | ✅ | | Upload video | ❌ |
| Messages list: load more on scroll | ✅ | | Grouped messages | ✅ |
| Messages list: receive new messages via subscription | ✅ | | Mark room as read | ❌ |
| Subscriptions list | ✅ | | Mark room as unread | ❌ |
| Segmented subscriptions list: Favorites | ✅ | | Tablet Support | ❌ |
| Segmented subscriptions list: Unreads | ✅ | | Read receipt | ❌ |
| Segmented subscriptions list: DMs | ✅ | | Broadbast Channel | ✅ |
| Segmented subscriptions list: Channels | ✅ | | Authentication via SAML | ❌ |
| Subscriptions list: update user status via subscription | ✅ | | Authentication via CAS | ❌ |
| Numbers os messages unread in the Subscriptions list | ✅ | | Custom Fields on Signup | ❌ |
| Status change | ✅ | | Report message | ❌ |
| Upload image | ✅ | | Theming | ❌ |
| Upload video | ❌ | | Settings -> Review the App | ❌ |
| Take picture & upload it | ✅ | | Settings -> Default Browser | ❌ |
| 2FA | ✅ | | Admin panel | ❌ |
| Signup | ✅ | | Reply message from notification | ❌ |
| Autocomplete with usernames | ✅ | | Unread counter banner on message list | ✅ |
| Autocomplete with @all & @here | ✅ | | E2E | ❌ |
| Autocomplete room/channel name | ✅ | | Join a Protected Room | ❌ |
| Upload audio | ✅ | | Optional Analytics | ❌ |
| Forgot your password | ✅ | | Settings -> About us | ❌ |
| Login screen: terms of service | ✅ | | Settings -> Contact us | ❌ |
| Login screen: privacy policy | ✅ | | Settings -> Update App Icon | ❌ |
| Authentication via Google | ✅ | | Settings -> Share | ❌ |
| Authentication via Facebook | ✅ | | Accessibility (Medium) | ❌ |
| Authentication via Twitter | ✅ | | Accessibility (Advanced) | ❌ |
| Authentication via GitHub | ✅ | | Authentication via Meteor | ❌ |
| Authentication via GitLab | ✅ | | Authentication via Wordpress | ❌ |
| Authentication via LinkedIn | ✅ | | Authentication via Custom OAuth | ❌ |
| Authentication via Meteor | ✅ | | Add user to the room | ✅ |
| Authentication via Wordpress | ❌ | | Send message | ✅ |
| Authentication via Custom OAuth | ❌ | | Authentication via Email | ✅ |
| Authentication via SAML | ❌ | | Authentication via Username | ✅ |
| Authentication via CAS | ❌ | | Authentication via LDAP | ✅ |
| Custom Fields on Signup | ❌ | | Message format: Markdown | ✅ |
| Create channel | ✅ | | Message format: System messages (Welcome, Message removed...) | ✅ |
| Search Local | ✅ | | Message format: links | ✅ |
| Search in the API | ✅ | | Message format: images | ✅ |
| Settings -> About us | ❌ | | Message format: replies | ✅ |
| Settings -> Contact us | ❌ | | Message format: alias with custom message (title & text) | ✅ |
| Settings -> License | ❌ | | Messages list: day separation | ✅ |
| Settings -> App version | ✅ | | Messages list: load more on scroll | ✅ |
| Autocomplete emoji | ✅ | | Messages list: receive new messages via subscription | ✅ |
| Upload file (documents, PDFs, spreadsheets, zip files, etc) | ✅ | | Subscriptions list | ✅ |
| Report message | ❌ | | Segmented subscriptions list: Favorites | ✅ |
| Copy message | ✅ | | Segmented subscriptions list: Unreads | ✅ |
| Pin message | ✅ | | Segmented subscriptions list: DMs | ✅ |
| Unpin message | ✅ | | Segmented subscriptions list: Channels | ✅ |
| Channel Info screen -> Members | ✅ | | Subscriptions list: update user status via subscription | ✅ |
| Channel Info screen -> Pinned | ✅ | | Numbers os messages unread in the Subscriptions list | ✅ |
| Channel Info screen -> Starred | ✅ | | Status change | ✅ |
| Channel Info screen -> Uploads | ✅ | | Upload image | ✅ |
| Star message | ✅ | | Take picture & upload it | ✅ |
| Unstar message | ✅ | | 2FA | ✅ |
| Channel Info screen -> Topic | ✅ | | Signup | ✅ |
| Channel Info screen -> Description | ✅ | | Autocomplete with usernames | ✅ |
| Star a channel | ✅ | | Autocomplete with @all & @here | ✅ |
| Message format: videos | ✅ | | Autocomplete room/channel name | ✅ |
| Message format: audios | ✅ | | Upload audio | ✅ |
| Block user (local only) | ✅ | | Forgot your password | ✅ |
| Edit message | ✅ | | Login screen: terms of service | ✅ |
| Delete a message | ✅ | | Login screen: privacy policy | ✅ |
| Reply message | ✅ | | Authentication via Google | ✅ |
| Quote message | ✅ | | Authentication via Facebook | ✅ |
| Record Audio | ✅ | | Authentication via Twitter | ✅ |
| Record Video | ❌ | | Authentication via GitHub | ✅ |
| Muted state | ✅ | | Authentication via GitLab | ✅ |
| Admin panel | ❌ | | Authentication via LinkedIn | ✅ |
| Offline reading | ✅ | | Create channel | ✅ |
| Offline writing | ❌ | | Search Local | ✅ |
| Edit profile | ✅ | | Search in the API | ✅ |
| Reactions | ✅ | | Settings -> License | ✅ |
| Custom emojis | ✅ | | Settings -> App version | ✅ |
| Commands | ❌ | | Autocomplete emoji | ✅ |
| Accessibility (Basic) | ✅ | | Upload file (documents, PDFs, spreadsheets, zip files, etc) | ✅ |
| Accessibility (Medium) | ❌ | | Copy message | ✅ |
| Accessibility (Advanced) | ❌ | | Pin message | ✅ |
| Reply message from notification | ❌ | | Unpin message | ✅ |
| Tap notification, go to the channel | ✅ | | Channel Info screen -> Members | ✅ |
| Deep links: Authentication | ✅ | | Channel Info screen -> Pinned | ✅ |
| Deep links: Rooms | ✅ | | Channel Info screen -> Starred | ✅ |
| Draft per room | ❌ | | Channel Info screen -> Uploads | ✅ |
| Localized in Portuguese (pt-BR) | ✅ | | Star message | ✅ |
| Localized in Russian | ✅ | | Unstar message | ✅ |
| Localized in English | ✅ | | Channel Info screen -> Topic | ✅ |
| Full name setting | ✅ | | Channel Info screen -> Description | ✅ |
| Read only rooms | ✅ | | Star a channel | ✅ |
| Typing status | ✅ | | Message format: videos | ✅ |
| Create channel/group | ✅ | | Message format: audios | ✅ |
| Disable registration setting | ✅ | | Edit message | ✅ |
| Unread red line indicator on message list | ✅ | | Delete a message | ✅ |
| Unread counter banner on message list | ✅ | | Reply message | ✅ |
| Share Extension | ❌ | | Quote message | ✅ |
| Search Messages in Channel | ✅ | | Muted state | ✅ |
| Mentions List | ✅ | | Offline reading | ✅ |
| Attachment List | ✅ | | Offline writing | ✅ |
| Notifications Preferences | ✅ | | Edit profile | ✅ |
| Read receipt | ❌ | | 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 | ✅ |
## Detox (end-to-end tests) ## Detox (end-to-end tests)
- Build your app - Build your app
```bash ```bash
$ detox build $ detox build --configuration ios.sim.release
``` ```
- Run tests - Run tests
```bash ```bash
$ detox test $ detox test --configuration ios.sim.release
``` ```