Giter VIP home page Giter VIP logo

orbit-core's Introduction

orbit-core

npm version CircleCI Status Project Status

Communication protocol on IPFS

Orbit is a serverless, distributed, p2p communication library and protocol that enables feed-based information sharing, such as real-time chat, in the IPFS peer-to-peer network.

This repository is the core library of Orbit. This library is intended to be used in your Node.js or Browser applications.

Used in the various Orbit projects:

Usage

Install

npm install orbit_

Example

See examples/browser/index.html for a more detailed example.

/* NOTE! To run this example, you need to have an IPFS daemon running */

'use strict'

const IpfsApi = require('ipfs-api')
const Orbit = require('orbit_')

const ipfs = IpfsApi()
const orbit = new Orbit(ipfs)

const channel = 'HelloWorld'

orbit.events.on('connected', (network) => {
  console.log(`-!- Connected to ${network.name}`)
  orbit.join(channel)
})

orbit.events.on('joined', (channel) => {
  orbit.send(channel, "/me is now caching this channel")
  console.log(`-!- Joined #${channel}`)
})

// Listen for new messages
orbit.events.on('message', (channel, post) => {
  console.log(`[${post.meta.ts}] < ${post.meta.from.name}> ${post.content}`)
})

// Connect to Orbit network
orbit.connect('Example Bot')
  .catch((e) => logger.error(e))

API

See API documentation for full details.

Development

Install Dependencies

git clone https://github.com/haadcode/orbit-core.git
cd orbit-core/
npm install

Run Tests

npm test

Build Library and Distributables

npm run build

Library (ES5 for older browsers and Node.js) will be located in lib/.

Distributable (ES5 minified for browsers) will be located in dist/.

License

MIT

orbit-core's People

Contributors

haadcode avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.