orbit core

inti orbit

Protokol komunikasi pada IPFS

Orbit adalah perpustakaan dan protokol komunikasi p2p tanpa server dan terdistribusi yang memungkinkan berbagi informasi berbasis feed, seperti obrolan waktu nyata, di jaringan peer-to-peer IPFS.

Repositori ini adalah perpustakaan inti Orbit. Pustaka ini dimaksudkan untuk digunakan di aplikasi Node.js atau Browser Anda.

Digunakan dalam berbagai proyek Orbit:

• orbit-web - Aplikasi browser Orbit
• orbit-elektron - Aplikasi desktop Orbit
• orbit-textui - Klien terminal orbit

Daftar isi

• Memasang
• Penggunaan
• API
• Perkembangan
  • Instal Dependensi
  • Jalankan Tes
  • Membangun Perpustakaan dan Dapat Didistribusikan
• Lisensi

Memasang

Modul ini menggunakan npm dan node.

npm install orbit_

Penggunaan

Lihat example/browser/index.html untuk contoh lebih detail.

 '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

Lihat dokumentasi API untuk detail selengkapnya.

• Memulai
• Konstruktor
• Properti
  • pengguna
  • jaringan
  • saluran
  • teman sebaya
• Metode
  • terhubung (nama pengguna)
  • memutuskan()
  • bergabung (saluran)
  • meninggalkan (saluran)
  • kirim (saluran, pesan)
  • addFile(saluran, sumber)
  • dapatkan File (hash)
  • dapatkanDirektori(hash)

Perkembangan

Instal Dependensi

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

Jalankan contoh lingkungan pengembangan

npm run dev

Jalankan Tes

npm test

Membangun Perpustakaan dan Dapat Didistribusikan

npm run build

Dapat didistribusikan (ES5 diperkecil untuk browser) akan ditempatkan di dist/ .

Menyumbang

Kami akan dengan senang hati menerima PR! Jika Anda ingin mengerjakan sesuatu, ada baiknya berbicara terlebih dahulu untuk memastikan tidak ada orang lain yang mengerjakannya. Anda dapat menghubungi kami di Gitter, atau di bagian masalah.

Kami juga mengadakan panggilan komunitas rutin , yang kami umumkan dalam terbitan di repositori selamat datang @orbitdb. Bergabunglah dengan kami!

Jika Anda ingin membuat kode tetapi tidak tahu harus mulai dari mana, lihat masalah berlabel "dibutuhkan bantuan".

Untuk pedoman spesifik dalam berkontribusi pada repositori ini, lihat panduan Berkontribusi. Untuk informasi lebih lanjut tentang berkontribusi pada OrbitDB secara umum, lihat repositori selamat datang @OrbitDB. Harap diingat bahwa semua interaksi di @OrbitDB tunduk pada Kode Etik kami.

Lisensi

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