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

252 lines
15 KiB
Markdown
Raw Normal View History

Create README.md
2017-08-16 17:44:26 +00:00
# Rocket.Chat React Native Mobile
Greenkeeper/initial (#71) * chore(package): update dependencies * docs(readme): add Greenkeeper badge
2017-11-13 20:55:58 +00:00
[![Greenkeeper badge](https://badges.greenkeeper.io/RocketChat/Rocket.Chat.ReactNative.svg)](https://greenkeeper.io/)
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
[![Build Status](https://img.shields.io/travis/RocketChat/Rocket.Chat.ReactNative/master.svg)](https://travis-ci.org/RocketChat/Rocket.Chat.ReactNative)
[![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)
Add vulnerabilities badge (#29)
2017-08-18 16:56:39 +00:00
[![Known Vulnerabilities](https://snyk.io/test/github/rocketchat/rocket.chat.reactnative/badge.svg)](https://snyk.io/test/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
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
**Supported Server Versions:** 0.66.0+
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
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
You can signup to our TestFlight builds by acessing this link: https://testflight.apple.com/join/7I3dLCNT.
### Android
You can get the latest Android builds at [#react-native](https://open.rocket.chat/channel/react-native) channel.
## Reporting an Issue
[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.
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 global add react-native-cli
$ 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
Update JS SDK version (#602)
2019-02-07 15:48:10 +00:00
$ yarn ios
Create README.md
2017-08-16 17:44:26 +00:00
```
```bash
Update JS SDK version (#602)
2019-02-07 15:48:10 +00:00
$ yarn android
Create README.md
2017-08-16 17:44:26 +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
### Running single server
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
If you don't need multiple servers, there is a branch `single-server` just for that.
Readme will guide you on how to config.
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
## Roadmap
### Current priorities
[CHORE] Add TestFlight invite and update Readme (#623)
2019-02-12 18:02:23 +00:00
1) [NEW] Jitsi integration
2) [NEW] Slash Commands ([#405][i405])
Bump version to 1.6.0 (#543)
2018-11-19 19:01:10 +00:00
3) [NEW] Read receipt ([#542][i542])
4) [Android] Group notifications by room ([#391][i391])
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
### To do
| Task | Status |
|--------------------|-----|
[CHORE] Add TestFlight invite and update Readme (#623)
2019-02-12 18:02:23 +00:00
| [NEW] Jitsi integration | WIP | |
[NEW] Message layout (#426) * message container/component * Separator component * Reply * Url * tests updated * Minor changes * Audio component * Broadcast button * Minor touches * Reply preview * Edited * Minor bug fixes * - Update roadmap - Bump version to 1.2 * Onboarding styles fix
2018-09-11 16:32:52 +00:00
| [NEW] Settings layout ([#396][i396]) | ❌ |
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
| [NEW] Contextual bar layout ([#402][i402]) | ❌ |
[CHORE] Add TestFlight invite and update Readme (#623)
2019-02-12 18:02:23 +00:00
| [NEW] Slash Commands ([#405][i405]) | ❌ |
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
| [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
[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
[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
Bump version to 1.6.0 (#543)
2018-11-19 19:01:10 +00:00
[i542]: https://github.com/RocketChat/Rocket.Chat.ReactNative/issues/542
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
| Feature | Status |
|----------------------------------------------------------------- |---------------- |
| 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 | ✅ |
[NEW] Message layout (#426) * message container/component * Separator component * Reply * Url * tests updated * Minor changes * Audio component * Broadcast button * Minor touches * Reply preview * Edited * Minor bug fixes * - Update roadmap - Bump version to 1.2 * Onboarding styles fix
2018-09-11 16:32:52 +00:00
| Segmented subscriptions list: Favorites | ✅ |
| Segmented subscriptions list: Unreads | ✅ |
| Segmented subscriptions list: DMs | ✅ |
| Segmented subscriptions list: Channels | ✅ |
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
| Subscriptions list: update user status via subscription | ✅ |
| Numbers os messages unread in the Subscriptions list | ✅ |
| Status change | ✅ |
| Upload image | ✅ |
| Upload video | ❌ |
| 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 | ✅ |
| Authentication via Meteor | ✅ |
| Authentication via Wordpress | ❌ |
| Authentication via Custom OAuth | ❌ |
| Authentication via SAML | ❌ |
| Authentication via CAS | ❌ |
| Custom Fields on Signup | ❌ |
| Create channel | ✅ |
| Search Local | ✅ |
| Search in the API | ✅ |
| Settings -> About us | ❌ |
| Settings -> Contact us | ❌ |
| Settings -> License | ❌ |
[CHORE] Add TestFlight invite and update Readme (#623)
2019-02-12 18:02:23 +00:00
| Settings -> App version | ✅ |
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
| Autocomplete emoji | ✅ |
| Upload file (documents, PDFs, spreadsheets, zip files, etc) | ✅ |
| Report message | ❌ |
| Copy message | ✅ |
| Pin message | ✅ |
| Unpin message | ✅ |
| Channel Info screen -> Members | ✅ |
| Channel Info screen -> Pinned | ✅ |
| Channel Info screen -> Starred | ✅ |
Use inline requires (#459) * Update dependencies * Lint and test * Added react-native fork * rn 57 * Lint and tests updated * Update xcode on circleci * Use legacy build system * Update tests * Inline requires * Fix eslint and remove temp gradle * Unnecessary renders * Update isNotch and Readme * Tests updated
2018-09-26 13:56:36 +00:00
| Channel Info screen -> Uploads | ✅ |
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
| Star message | ✅ |
| Unstar message | ✅ |
| Channel Info screen -> Topic | ✅ |
| Channel Info screen -> Description | ✅ |
| Star a channel | ✅ |
| Message format: videos | ✅ |
| Message format: audios | ✅ |
| Block user (local only) | ✅ |
| Edit message | ✅ |
| Delete a message | ✅ |
| Reply message | ✅ |
| Quote message | ✅ |
| Record Audio | ✅ |
| Record Video | ❌ |
| Muted state | ✅ |
| Admin panel | ❌ |
| Offline reading | ✅ |
| Offline writing | ❌ |
| Edit profile | ✅ |
| Reactions | ✅ |
| Custom emojis | ✅ |
| Commands | ❌ |
| Accessibility (Basic) | ✅ |
| Accessibility (Medium) | ❌ |
| Accessibility (Advanced) | ❌ |
| Reply message from notification | ❌ |
| Tap notification, go to the channel | ✅ |
| Deep links: Authentication | ✅ |
| Deep links: Rooms | ✅ |
| Draft per room | ❌ |
Use inline requires (#459) * Update dependencies * Lint and test * Added react-native fork * rn 57 * Lint and tests updated * Update xcode on circleci * Use legacy build system * Update tests * Inline requires * Fix eslint and remove temp gradle * Unnecessary renders * Update isNotch and Readme * Tests updated
2018-09-26 13:56:36 +00:00
| Localized in Portuguese (pt-BR) | ✅ |
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
| Localized in Russian | ✅ |
| Localized in English | ✅ |
[NEW] Message layout (#426) * message container/component * Separator component * Reply * Url * tests updated * Minor changes * Audio component * Broadcast button * Minor touches * Reply preview * Edited * Minor bug fixes * - Update roadmap - Bump version to 1.2 * Onboarding styles fix
2018-09-11 16:32:52 +00:00
| Full name setting | ✅ |
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
| Read only rooms | ✅ |
| Typing status | ✅ |
| Create channel/group | ✅ |
| Disable registration setting | ✅ |
| Unread red line indicator on message list | ✅ |
| Unread counter banner on message list | ✅ |
| Share Extension | ❌ |
| Search Messages in Channel | ✅ |
| Mentions List | ✅ |
| Attachment List | ✅ |
| Notifications Preferences | ✅ |
| Read receipt | ❌ |
## Detox (end-to-end tests)
Detox tests E2E (#283)
2018-05-23 13:39:18 +00:00
- Build your app
```bash
$ detox build
```
- Run tests
```bash
$ detox test
```
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
## Storybook
Integrate storybook
2017-08-17 19:31:27 +00:00
- General requirements
- Install storybook
```bash
Update JS SDK version (#602)
2019-02-07 15:48:10 +00:00
$ yarn global add @storybook/cli
Integrate storybook
2017-08-17 19:31:27 +00:00
```
- Running storybook
- Run storybook application
```bash
Update JS SDK version (#602)
2019-02-07 15:48:10 +00:00
$ yarn storybook
Integrate storybook
2017-08-17 19:31:27 +00:00
```
- Run application in other shell
```bash
$ react-native run-ios
```
- Running storybook on browser to help stories navigation
```
open http://localhost:7007/
```