Skip to content

Yhozen/peerweb.js

 
 

Repository files navigation

PeerWeb.js

Code Climate Dependency Status devDependency Status Standard - JavaScript Style Guide npm npm

A package to download and render a decentralised webpage thanks to WebTorrent. It's in alpha so a lot of bugs are expected.

Install via npm

$ npm install --save peerweb

Usage

Build a simple static webpage and then create a torrent (instant.io for simplicity) with the whole folder like the following example

├── js
│   ├── main.js
│   └── other.js
├── imgs
│   ├── foo.png
│   └── bar.png
├── css
│   └── main.css
└── index.html

get the magnet link and then use it in a webpage like this

import PeerWeb  from 'peerweb'

const peerweb = new PeerWeb(true) // true for debug

peerweb.render(YOUR_MAGNET_LINK)

Contribute

Feel free to create pull request and issues with bugs or feature request. There are tons of features planned as render index faster, do not redownload files, get magnet link from files... etc.

About

A client side library for fetching and rendering a static website via torrent over WebRTC

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 93.5%
  • HTML 6.5%