Commit a41e82b9 authored by Alton Roland's avatar Alton Roland

fairchat README

parent dc8609fb
# Rocket.Chat React Native Mobile
## fairchat App
[![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)
[![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)
React-native based mobile chat app for Android and iOS.
Connects to any Rocket.Chat server v0.70+ via meteor DDP and REST API.
**Supported Server Versions:** 0.70.0+
Customized version for fairchat.net provided by osAlliance.com
Forked from https://github.com/RocketChat/Rocket.Chat.ReactNative
## Download
<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>
## License
MIT
## Beta Access
## Issues & Feature requests
### TestFlight
https://git.fairkom.net/chat/fairchat.ReactNative
You can signup to our TestFlight builds by acessing this link: https://testflight.apple.com/join/7I3dLCNT.
## Contact
### Google Play beta
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
[Github Issues](https://github.com/RocketChat/Rocket.Chat.ReactNative/issues) are used to track todos, bugs, feature requests, and more.
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
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.
## How to run
- Clone repository and install dependencies:
```bash
$ git clone git@github.com:RocketChat/Rocket.Chat.ReactNative.git
$ cd Rocket.Chat.ReactNative
$ yarn global add react-native-cli
$ yarn
```
- Run application
```bash
$ react-native run-ios
```
```bash
$ react-native run-android
```
### Running single server
If you don't need multiple servers, there is a branch `single-server` just for that.
Readme will guide you on how to config.
## Current priorities
1) Jitsi integration
2) Notification Preferences
3) Two-way authentication
4) Bugsnag
5) Optional Analytics
6) Typescript
7) Prettier
fairkom is an official Rocket.Chat partner and offers customized versions or integrations.
Talk to us, if you would like to see more features or need your own app: sales@fairkom.eu
## Features
| Feature | Status |
|--------------------------------------------------------------- |-------- |
| Jitsi Integration | ✅ |
| Jitsi Video Integration | ✅ |
| Federation (Directory) | ✅ |
| Discussions | ❌ |
| Threads | ✅ |
......@@ -98,11 +52,11 @@ Readme will guide you on how to config.
| Unread counter banner on message list | ✅ |
| E2E Encryption | ❌ |
| Join a Protected Room | ❌ |
| Optional Analytics | |
| Optional Analytics | |
| Settings -> About us | ❌ |
| Settings -> Contact us | ✅ |
| Settings -> Update App Icon | ❌ |
| Settings -> Share | |
| Settings -> Share | |
| Accessibility (Medium) | ❌ |
| Accessibility (Advanced) | ❌ |
| Authentication via Meteor | ❌ |
......@@ -191,38 +145,3 @@ Readme will guide you on how to config.
| Search Messages in Channel | ✅ |
| Mentions List | ✅ |
| Attachment List | ✅ |
| Join a Room | ✅ |
## Detox (end-to-end tests)
- Build your app
```bash
$ detox build --configuration ios.sim.release
```
- Run tests
```bash
$ detox test --configuration ios.sim.release
```
## 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
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment