From 11e04495ae873ecbdbc25f42ab367196f884e0b0 Mon Sep 17 00:00:00 2001 From: David Dias Date: Mon, 3 Jul 2017 08:57:16 +0100 Subject: [PATCH] structure examples --- examples/README.md | 15 +++++++++++---- .../mapper/.gitignore | 0 .../mapper/package.json | 0 .../mapper/public/index.html | 0 .../mapper/src/create-node.js | 2 +- .../mapper/src/index.js | 0 .../chat/dialer.js | 3 +-- .../chat/listener.js | 2 +- .../chat/peer-id-dialer.json | 0 .../chat/peer-id-listener.json | 0 .../echo/dialer.js | 2 +- .../echo/id-d.json | 0 .../echo/id-l.json | 0 .../echo/listener.js | 2 +- 14 files changed, 16 insertions(+), 10 deletions(-) rename examples/{examples-ipfs-browser-bundle => browser}/mapper/.gitignore (100%) rename examples/{examples-ipfs-browser-bundle => browser}/mapper/package.json (100%) rename examples/{examples-ipfs-browser-bundle => browser}/mapper/public/index.html (100%) rename examples/{examples-ipfs-browser-bundle => browser}/mapper/src/create-node.js (87%) rename examples/{examples-ipfs-browser-bundle => browser}/mapper/src/index.js (100%) rename examples/{examples-ipfs-nodejs-bundle => nodejs}/chat/dialer.js (95%) rename examples/{examples-ipfs-nodejs-bundle => nodejs}/chat/listener.js (94%) rename examples/{examples-ipfs-nodejs-bundle => nodejs}/chat/peer-id-dialer.json (100%) rename examples/{examples-ipfs-nodejs-bundle => nodejs}/chat/peer-id-listener.json (100%) rename examples/{examples-ipfs-nodejs-bundle => nodejs}/echo/dialer.js (95%) rename examples/{examples-ipfs-nodejs-bundle => nodejs}/echo/id-d.json (100%) rename examples/{examples-ipfs-nodejs-bundle => nodejs}/echo/id-l.json (100%) rename examples/{examples-ipfs-nodejs-bundle => nodejs}/echo/listener.js (93%) diff --git a/examples/README.md b/examples/README.md index fc8ae2e299..d0d3503ab4 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,6 +1,13 @@ -### Examples list +# `js-libp2p` Examples and Tutorials -Here are some examples built with libp2p bundles. +In this folder, you can find a variety of examples to help you get started in using js-libp2p, in Node.js and in the Browser. Every example as a specific purpose and some of each incorporate a full tutorial that you can follow through, helping you expand your knowledge about libp2p and p2p networks in general. -- https://github.com/ipfs/js-libp2p-ipfs/tree/master/examples/echo -- https://github.com/ipfs/js-libp2p-ipfs/tree/master/examples/chat +Let us know if you find any issue or if you want to contribute and add a new tutorial, feel welcome to submit a PR, thank you! + +## Examples + +- [In Node.js](./nodejs) + - [echo](./nodejs/echo) + - [chat](./nodejs/chat) +- [In the browser](./browser) + - [mapper](./browser/mapper) diff --git a/examples/examples-ipfs-browser-bundle/mapper/.gitignore b/examples/browser/mapper/.gitignore similarity index 100% rename from examples/examples-ipfs-browser-bundle/mapper/.gitignore rename to examples/browser/mapper/.gitignore diff --git a/examples/examples-ipfs-browser-bundle/mapper/package.json b/examples/browser/mapper/package.json similarity index 100% rename from examples/examples-ipfs-browser-bundle/mapper/package.json rename to examples/browser/mapper/package.json diff --git a/examples/examples-ipfs-browser-bundle/mapper/public/index.html b/examples/browser/mapper/public/index.html similarity index 100% rename from examples/examples-ipfs-browser-bundle/mapper/public/index.html rename to examples/browser/mapper/public/index.html diff --git a/examples/examples-ipfs-browser-bundle/mapper/src/create-node.js b/examples/browser/mapper/src/create-node.js similarity index 87% rename from examples/examples-ipfs-browser-bundle/mapper/src/create-node.js rename to examples/browser/mapper/src/create-node.js index 1729291832..6e364560f5 100644 --- a/examples/examples-ipfs-browser-bundle/mapper/src/create-node.js +++ b/examples/browser/mapper/src/create-node.js @@ -1,7 +1,7 @@ 'use strict' const PeerInfo = require('peer-info') -const Node = require('../../../src') +const Node = require('../../../../test/browser-bundle/browser-bundle.js') function createNode (callback) { PeerInfo.create((err, peerInfo) => { diff --git a/examples/examples-ipfs-browser-bundle/mapper/src/index.js b/examples/browser/mapper/src/index.js similarity index 100% rename from examples/examples-ipfs-browser-bundle/mapper/src/index.js rename to examples/browser/mapper/src/index.js diff --git a/examples/examples-ipfs-nodejs-bundle/chat/dialer.js b/examples/nodejs/chat/dialer.js similarity index 95% rename from examples/examples-ipfs-nodejs-bundle/chat/dialer.js rename to examples/nodejs/chat/dialer.js index 179519dd78..88ae5cd4c6 100644 --- a/examples/examples-ipfs-nodejs-bundle/chat/dialer.js +++ b/examples/nodejs/chat/dialer.js @@ -3,10 +3,9 @@ const PeerId = require('peer-id') const PeerInfo = require('peer-info') -const Node = require('../../src') +const Node = require('../../../../test/nodejs-bundle/nodejs-bundle.js') const multiaddr = require('multiaddr') const pull = require('pull-stream') -// const toPull = require('stream-to-pull-stream') const async = require('async') const Pushable = require('pull-pushable') const p = Pushable() diff --git a/examples/examples-ipfs-nodejs-bundle/chat/listener.js b/examples/nodejs/chat/listener.js similarity index 94% rename from examples/examples-ipfs-nodejs-bundle/chat/listener.js rename to examples/nodejs/chat/listener.js index ccd60ecfdf..435ab8ff80 100644 --- a/examples/examples-ipfs-nodejs-bundle/chat/listener.js +++ b/examples/nodejs/chat/listener.js @@ -3,7 +3,7 @@ const PeerId = require('peer-id') const PeerInfo = require('peer-info') -const Node = require('../../src') +const Node = require('../../../../test/nodejs-bundle/nodejs-bundle.js') const multiaddr = require('multiaddr') const pull = require('pull-stream') const Pushable = require('pull-pushable') diff --git a/examples/examples-ipfs-nodejs-bundle/chat/peer-id-dialer.json b/examples/nodejs/chat/peer-id-dialer.json similarity index 100% rename from examples/examples-ipfs-nodejs-bundle/chat/peer-id-dialer.json rename to examples/nodejs/chat/peer-id-dialer.json diff --git a/examples/examples-ipfs-nodejs-bundle/chat/peer-id-listener.json b/examples/nodejs/chat/peer-id-listener.json similarity index 100% rename from examples/examples-ipfs-nodejs-bundle/chat/peer-id-listener.json rename to examples/nodejs/chat/peer-id-listener.json diff --git a/examples/examples-ipfs-nodejs-bundle/echo/dialer.js b/examples/nodejs/echo/dialer.js similarity index 95% rename from examples/examples-ipfs-nodejs-bundle/echo/dialer.js rename to examples/nodejs/echo/dialer.js index b10e7c4927..c3093292f6 100644 --- a/examples/examples-ipfs-nodejs-bundle/echo/dialer.js +++ b/examples/nodejs/echo/dialer.js @@ -7,7 +7,7 @@ const PeerId = require('peer-id') const PeerInfo = require('peer-info') -const Node = require('../../src') +const Node = require('../../../../test/nodejs-bundle/nodejs-bundle.js') const multiaddr = require('multiaddr') const pull = require('pull-stream') const async = require('async') diff --git a/examples/examples-ipfs-nodejs-bundle/echo/id-d.json b/examples/nodejs/echo/id-d.json similarity index 100% rename from examples/examples-ipfs-nodejs-bundle/echo/id-d.json rename to examples/nodejs/echo/id-d.json diff --git a/examples/examples-ipfs-nodejs-bundle/echo/id-l.json b/examples/nodejs/echo/id-l.json similarity index 100% rename from examples/examples-ipfs-nodejs-bundle/echo/id-l.json rename to examples/nodejs/echo/id-l.json diff --git a/examples/examples-ipfs-nodejs-bundle/echo/listener.js b/examples/nodejs/echo/listener.js similarity index 93% rename from examples/examples-ipfs-nodejs-bundle/echo/listener.js rename to examples/nodejs/echo/listener.js index b8ed69df6e..812dfc43d3 100644 --- a/examples/examples-ipfs-nodejs-bundle/echo/listener.js +++ b/examples/nodejs/echo/listener.js @@ -7,7 +7,7 @@ const PeerId = require('peer-id') const PeerInfo = require('peer-info') -const Node = require('../../src') +const Node = require('../../../../test/nodejs-bundle/nodejs-bundle.js') const multiaddr = require('multiaddr') const pull = require('pull-stream') const series = require('async/series')