73 lines
3.6 KiB
Markdown
73 lines
3.6 KiB
Markdown
# Tinode Web
|
|
|
|
## Briefing
|
|
|
|
Single-page web chat application for [Tinode](https://github.com/tinode/chat/). The app is built on
|
|
[React](https://reactjs.org/). The [Tinode javascript SDK](https://github.com/tinode/tinode-js/) has no external dependencies.
|
|
Overall, it's a lot like open source WhatsApp or Telegram web apps.
|
|
|
|
Although the app is generally usable, keep in mind that this is work in progress. Some bugs probably exist, some features are missing. The app was tested in the latest Chrome & Firefox only. NPM package is [available](https://www.npmjs.com/package/tinode-webapp).
|
|
|
|
Try possibly newer or older version live at https://sandbox.tinode.co/.
|
|
|
|
<a href="https://web.tinode.co/"><img src="web-app.svg" height=36></a>
|
|
|
|
For demo access and other instructions [see here](https://github.com/tinode/chat/#demosandbox).
|
|
|
|
## Installing and running
|
|
|
|
This is _NOT_ a standalone app, this is just a frontend, a client. It requires a [backend](https://github.com/tinode/chat/). See [installation instructions](https://github.com/tinode/chat/blob/master/INSTALL.md). See instructions for [enabling push notifications](push.md).
|
|
|
|
## Getting support
|
|
|
|
* Read [client-side](http://tinode.github.io/js-api/) and [server-side](https://github.com/tinode/chat/blob/master/docs/API.md) API documentation.
|
|
* For support, general questions, discussions post to [https://groups.google.com/d/forum/tinode](https://groups.google.com/d/forum/tinode).
|
|
* For bugs and feature requests [open an issue](https://github.com/tinode/webchat/issues/new).
|
|
* Use https://tinode.co/contact for commercial inquiries.
|
|
|
|
## Internationalization
|
|
|
|
The app is fully internationalized using [React-Intl](https://github.com/formatjs/react-intl). The UI language is selected automatically from the language specified by the browser. A specific language can be forced by adding `#?hl=XX` parameter to the URL when starting the app, e.g. https://web.tinode.co/#?hl=ru.
|
|
|
|
The app is currently available in the following languages:
|
|
* English
|
|
* Chinese (simplified)
|
|
* Chinese (traditional)
|
|
* German
|
|
* Korean
|
|
* Romanian
|
|
* Russian
|
|
* Spanish
|
|
|
|
More translations are welcome. See [instructions](https://github.com/tinode/chat/blob/devel/docs/translations.md#webapp).
|
|
|
|
|
|
## Not done yet
|
|
|
|
* Video or audio calling.
|
|
* End-to-End encryption.
|
|
* Emoji support is weak.
|
|
* Mentions, hashtags.
|
|
* Previews not generated for videos, links or docs.
|
|
|
|
## Other
|
|
|
|
* Demo avatars and some other graphics are from https://www.pexels.com/ under [CC0 license](https://www.pexels.com/photo-license/).
|
|
* Background patterns from http://subtlepatterns.com/, commercial and non-commercial use allowed with attribution.
|
|
* [Fonts](https://fonts.google.com/) and [icons](https://google.github.io/material-design-icons/#icon-font-for-the-web) from Google under [license](https://developers.google.com/terms) which permits commercial and non-commercial use.
|
|
* Push notifications built with https://firebase.google.com/.
|
|
|
|
## Responsive design
|
|
|
|
### Desktop screenshot
|
|
|
|
<p align="center">
|
|
<img src="web-desktop.jpg" alt="Desktop web: full app" width=810 />
|
|
</p>
|
|
|
|
### Mobile screenshots
|
|
|
|
<p align="center">
|
|
<kbd><img src="web-mob-contacts.png" alt="Mobile web: contacts" width=250 /></kbd> <kbd><img src="web-mob-chat.png" alt="Mobile web: chat" width=250 /></kbd> <kbd><img src="web-mob-info.png" alt="Mobile web: topic info" width=250 /></kbd> <kbd><img src="web-mob-forward.png" alt="Mobile web: forward message" width=250 /></kbd> <kbd><img src="web-mob-acc-settings.png" alt="Mobile web: account settings" width=250 /></kbd> <kbd><img src="web-mob-avatar.png" alt="Mobile web: change avatar" width=250 /></kbd>
|
|
</p>
|