orbit core

núcleo orbital

Protocolo de comunicación en IPFS

Orbit es una biblioteca y un protocolo de comunicación p2p distribuido y sin servidor que permite compartir información basada en feeds, como el chat en tiempo real, en la red peer-to-peer de IPFS.

Este repositorio es la biblioteca principal de Orbit. Esta biblioteca está diseñada para usarse en sus aplicaciones Node.js o de navegador.

Utilizado en los distintos proyectos de Orbit:

• orbit-web - Aplicación de navegador Orbit
• orbit-electron - Aplicación de escritorio Orbit
• orbit-textui - Cliente de terminal Orbit

Tabla de contenido

• Instalar
• Uso
• API
• Desarrollo
  • Instalar dependencias
  • Ejecutar pruebas
  • Crear biblioteca y distribuibles
• Licencia

Instalar

Este módulo utiliza npm y node.

npm install orbit_

Uso

Consulte ejemplos/browser/index.html para obtener un ejemplo más detallado.

 'use strict'

const Orbit = require ( 'orbit_' )

const ipfs = new Ipfs ( )

ipfs . on ( 'ready' , ( ) => {
  const orbit = new Orbit ( ipfs )

  const username = 'Example Bot'
  const channel = 'HelloWorld'

  orbit . events . on ( 'connected' , ( ) => {
    console . log ( `-!- Orbit connected` )
    orbit . join ( channel )
  } )

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

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

  // Connect to Orbit network
  orbit . connect ( username ) . catch ( e => console . error ( e ) )
} ) 

API

Consulte la documentación de la API para obtener todos los detalles.

• Empezando
• Constructor
• Propiedades
  • usuario
  • red
  • canales
  • colegas
• Métodos
  • conectar (nombre de usuario)
  • desconectar()
  • unirse (canal)
  • salir (canal)
  • enviar (canal, mensaje)
  • addFile(canal, fuente)
  • obtener archivo (hash)
  • obtenerDirectorio(hash)

Desarrollo

Instalar dependencias

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

Ejecutar un entorno de desarrollo de ejemplo

npm run dev

Ejecutar pruebas

npm test

Crear biblioteca y distribuibles

npm run build

Distribuible (ES5 minificado para navegadores) se ubicará en dist/ .

Contribuir

¡Estaremos encantados de aceptar relaciones públicas! Si quieres trabajar en algo, sería bueno hablar de antemano para asegurarte de que nadie más esté trabajando en ello. Puede comunicarse con nosotros en Gitter o en la sección de problemas.

También realizamos llamadas comunitarias periódicas , que anunciamos en los números del repositorio de bienvenida @orbitdb. ¡Únete a nosotros!

Si desea codificar pero no sabe por dónde empezar, consulte los problemas etiquetados como "se busca ayuda".

Para conocer pautas específicas para contribuir a este repositorio, consulte la guía de contribución. Para obtener más información sobre cómo contribuir a OrbitDB en general, consulte el repositorio de bienvenida de @OrbitDB. Tenga en cuenta que todas las interacciones en @OrbitDB se rigen por nuestro Código de conducta.

Licencia

MIT © 2016-2019 Protocol Labs Inc., Haja Networks Oy