iris-node

by irislib

GitHub Readme.md

iris-lib

Node NPM Travis David Coverage Status Gitmoji

Description

Iris-lib allows you to integrate decentralized social networking features into your application.

Public messaging: Add a troll-free comment box to your website or app.

Private chats: Don't reinvent the wheel - just deploy iris-lib for real-time private and group discussions. No phone number or other "account" needed - just a public key verified by friends.

Web of trust: Filter out spam and other unwanted content, without giving power to central moderators. Iris public and private messages are automatically filtered. You can also filter your own datasets by user's web of trust distance.

Contacts management: Ask friends to verify your public key or cryptocurrency address and changes to them. Use verified payment addresses in crypto wallets. Use verified public keys for authentication instead of relying on centralized email addresses, domain names and passwords. Any other types of attributes can also be added and verified.

Iris-lib runs in the browser and on Node.js.

Usage

Library integration: see Iris API for documentation and tests directory for examples.

Server script:

npm start

Deploy to Heroku:

Deploy

TODO: docker instructions

Tech

Data storage and networking are outsourced to GUN, which manages the synchronization of data between different storages: RAM, localstorage, GUN websocket server, WebRTC peers, LAN multicast peers, IPFS (no adapter yet), S3 or others.

GUN enables subscription to data changes, so message feeds and identity profiles just update real-time without having to hit f5 or writing complex update logic.

IPFS is used to store file attachments and optional message backups.

Installation

Install via yarn

yarn add iris-lib (--dev)

or npm

npm install iris-lib (--save-dev)

Builds

If you don't use a package manager, you can access iris-lib via unpkg (CDN), download the source, or point your package manager to the url.

iris-lib is compiled as a collection of CommonJS modules & ES2015 modules for bundlers that support the jsnext:main or module field in package.json (Rollup, Webpack 2)

The iris-lib package includes precompiled production and development UMD builds in the dist folder. They can be used directly without a bundler and are thus compatible with many popular JavaScript module loaders and environments. You can drop a UMD build as a <script> tag on your page. The UMD builds make iris-lib available as a window.irisLib global variable.

License

The code is available under the MIT license.

Contributing

Please do integrate iris-lib with your existing application or with a test application and create Github issues for the bugs and other problems you may encounter. Your help is much appreciated!

TODO list is also available on Trello.

Majestic is a handy tool for viewing jest test results and coverage.

Misc

This module was created using generator-module-boilerplate.