iris-messenger/README.md

60 lines
2.6 KiB
Markdown
Raw Normal View History

2021-08-09 12:10:15 +00:00
# Iris
Iris is like the social networking apps we're used to, but better.
* No phone number or signup required. Just type in your name or alias and go!
* Secure: It's open source. Users can validate that big brother doesn't read your private messages.
* Available: It works offline-first and is not dependent on any single centrally managed server. Users can even connect directly to each other.
![Screenshot](screenshot.png)
2021-08-09 12:10:15 +00:00
## Use
Browser application: [iris.to](https://iris.to)
* No installation required
* Progressive web app
* Use offline
* Save as an app to home screen or desktop
Desktop application: ([download](https://github.com/irislib/iris-electron/releases), [source code](https://github.com/irislib/iris-electron)):
* Communicate and synchronize with local network peers without Internet access
* When local peers eventually connect to the Internet, your messages are relayed globally
* Bluetooth support upcoming
* Opens to background on login: stay online and get message notifications!
* More secure and available: no need to open the browser application from a server.
## Develop
2021-07-08 21:31:30 +00:00
``` bash
# install dependencies
2021-08-09 12:10:15 +00:00
yarn
2020-01-14 08:41:30 +00:00
2021-07-08 21:31:30 +00:00
# serve with hot reload at localhost:8080
2021-08-09 12:10:15 +00:00
yarn dev
2020-01-30 10:21:43 +00:00
2021-07-08 21:31:30 +00:00
# build for production with minification
2021-08-09 12:10:15 +00:00
yarn build
2020-01-30 11:10:53 +00:00
2021-07-08 21:31:30 +00:00
# test the production build locally
2021-08-09 12:10:15 +00:00
yarn serve
2020-01-30 11:10:53 +00:00
2021-07-08 21:31:30 +00:00
# run tests with jest and enzyme
2021-08-09 12:10:15 +00:00
yarn test
2021-07-08 21:31:30 +00:00
```
2020-12-20 07:14:18 +00:00
2021-08-09 12:10:15 +00:00
## Privacy
The application is an unaudited proof-of-concept implementation, so don't use it for security critical purposes.
2021-08-09 12:10:15 +00:00
Private messages are end-to-end encrypted, but message timestamps and the number of chats aren't. In a decentralized network this information is potentially available to anyone.
By looking at timestamps in chats, it is possible to guess who are chatting with each other. It is also possible, if not trivial, to find out who are communicating with each other by monitoring data subscriptions on the decentralized database.
In that regard, Iris prioritizes decentralization and availability over perfect privacy.
Profile names, photos and online status are currently public. That can be changed when advanced group permissions are developed.
## Contact
2022-06-15 07:43:34 +00:00
Join our [Discord](https://discord.gg/4CJc74JEUY) (will be moved onto Iris when group chat is ready) or send me a message on [Iris](https://iris.to/?chatWith=hyECQHwSo7fgr2MVfPyakvayPeixxsaAWVtZ-vbaiSc.TXIp8MnCtrnW6n2MrYquWPcc-DTmZzMBmc2yaGv9gIU&s=HlzYzNrhUsrn2PLi4yuRt6DiFUNM3hOmN8nFpgw6T-g&k=zvDfsInsMOI1).
2021-08-09 12:10:15 +00:00
---
2021-08-03 21:45:17 +00:00
2021-08-09 12:10:15 +00:00
<a href="https://opencollective.com/iris-social/donate" target="_blank"><img src="https://opencollective.com/iris-social/donate/button@2x.png?color=blue" width=200 /></a>
2021-08-03 21:45:17 +00:00
2021-08-09 12:10:15 +00:00
<p><sub>BTC donations: 3GopC1ijpZktaGLXHb7atugPj9zPGyQeST</sub></p>