Skip to content
This repository was archived by the owner on Jan 12, 2024. It is now read-only.

Commit b461ec5

Browse files
oliveriosousaoliveriosousa
authored
feat: add proto school link for tutorials (#31)
* feat: add proto school link for tutorials * fix: update examples link
1 parent d8684d5 commit b461ec5

File tree

32 files changed

+534
-523
lines changed

32 files changed

+534
-523
lines changed

‎README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@
77
<h3 align="center"><b>JS IPFS Examples</b></h3>
88

99
<p align="center">
10-
<b><i>Collection of js-ipfs examples</i></b>
11-
<br />
12-
<br />
13-
<img src="https://raw.githubusercontent.com/jlord/forkngo/gh-pages/badges/cobalt.png" width="200">
14-
<br>
15-
<a href="https://github.com/ipfs/js-ipfs/tree/master/docs">Explore the docs</a>
16-
·
17-
<a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Report Bug</a>
18-
·
19-
<a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Request Feature/Example</a>
20-
</p>
10+
<b><i>Collection of js-ipfs examples</i></b>
11+
<br />
12+
<br />
13+
<img src="https://raw.githubusercontent.com/jlord/forkngo/gh-pages/badges/cobalt.png" width="200">
14+
<br>
15+
<a href="https://github.com/ipfs/js-ipfs/tree/master/docs">Explore the docs</a>
16+
·
17+
<a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Report Bug</a>
18+
·
19+
<a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Request Feature/Example</a>
20+
</p>
2121

2222
## Table of Contents
2323

@@ -35,7 +35,7 @@
3535
## About The Project
3636

3737
- Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs)
38-
- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser
38+
- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser
3939
- Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node
4040
- Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it
4141
- Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs
@@ -82,8 +82,9 @@ Explore [ProtoSchool's IPFS tutorials](https://proto.school/#/tutorials?course=i
8282

8383
- [Config](https://docs.ipfs.io/)
8484
- [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api)
85-
- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples)
85+
- [Examples](https://github.com/ipfs-examples/js-ipfs-examples)
8686
- [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md)
87+
- [Tutorials](https://proto.school)
8788

8889
## Contributing
8990

‎examples/browser-add-readable-stream/README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@
77
<h3 align="center"><b>Readable Stream</b></h3>
88

99
<p align="center">
10-
<b><i>Using duplex streams to add files to IPFS in the browser</i></b>
11-
<br />
12-
<br />
13-
<img src="https://raw.githubusercontent.com/jlord/forkngo/gh-pages/badges/cobalt.png" width="200">
14-
<br>
15-
<a href="https://github.com/ipfs/js-ipfs/tree/master/docs">Explore the docs</a>
16-
·
17-
<a href="https://codesandbox.io/">View Demo</a>
18-
·
19-
<a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Report Bug</a>
20-
·
21-
<a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Request Feature/Example</a>
22-
</p>
10+
<b><i>Using duplex streams to add files to IPFS in the browser</i></b>
11+
<br />
12+
<br />
13+
<img src="https://raw.githubusercontent.com/jlord/forkngo/gh-pages/badges/cobalt.png" width="200">
14+
<br>
15+
<a href="https://github.com/ipfs/js-ipfs/tree/master/docs">Explore the docs</a>
16+
·
17+
<a href="https://codesandbox.io/">View Demo</a>
18+
·
19+
<a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Report Bug</a>
20+
·
21+
<a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Request Feature/Example</a>
22+
</p>
2323

2424
## Table of Contents
2525

@@ -36,7 +36,7 @@
3636
## About The Project
3737

3838
- Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs)
39-
- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser
39+
- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser
4040
- Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node
4141
- Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it
4242
- Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs
@@ -76,8 +76,9 @@ _For more examples, please refer to the [Documentation](#documentation)_
7676

7777
- [Config](https://docs.ipfs.io/)
7878
- [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api)
79-
- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples)
79+
- [Examples](https://github.com/ipfs-examples/js-ipfs-examples)
8080
- [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md)
81+
- [Tutorials](https://proto.school)
8182

8283
## Contributing
8384

‎examples/browser-angular/README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@
77
<h3 align="center"><b>IPFS React App</b></h3>
88

99
<p align="center">
10-
<b><i>Using js-ipfs in a `create-react-app`</i></b>
11-
<br />
12-
<br />
13-
<img src="https://raw.githubusercontent.com/jlord/forkngo/gh-pages/badges/cobalt.png" width="200">
14-
<br>
15-
<a href="https://github.com/ipfs/js-ipfs/tree/master/docs">Explore the docs</a>
16-
·
17-
<a href="https://codesandbox.io/">View Demo</a>
18-
·
19-
<a href="https://github.com/ipfs/js-ipfs/issues">Report Bug</a>
20-
·
21-
<a href="https://github.com/ipfs/js-ipfs/issues">Request Feature</a>
22-
</p>
10+
<b><i>Using js-ipfs in a `create-react-app`</i></b>
11+
<br />
12+
<br />
13+
<img src="https://raw.githubusercontent.com/jlord/forkngo/gh-pages/badges/cobalt.png" width="200">
14+
<br>
15+
<a href="https://github.com/ipfs/js-ipfs/tree/master/docs">Explore the docs</a>
16+
·
17+
<a href="https://codesandbox.io/">View Demo</a>
18+
·
19+
<a href="https://github.com/ipfs/js-ipfs/issues">Report Bug</a>
20+
·
21+
<a href="https://github.com/ipfs/js-ipfs/issues">Request Feature</a>
22+
</p>
2323

2424
## Table of Contents
2525

@@ -43,7 +43,7 @@
4343
## About The Project
4444

4545
- Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs)
46-
- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser
46+
- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser
4747
- Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node
4848
- Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it
4949
- Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs
@@ -67,7 +67,7 @@ Make sure you have installed all of the following prerequisites on your developm
6767
> npm start
6868
```
6969

70-
Now open your browser at `http://localhost:3000`
70+
Now open your browser at `http://localhost:4200`
7171

7272
### Available Scripts from create-react-app
7373

@@ -109,8 +109,9 @@ _For more examples, please refer to the [Documentation](#documentation)_
109109

110110
- [Config](https://docs.ipfs.io/)
111111
- [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api)
112-
- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples)
112+
- [Examples](https://github.com/ipfs-examples/js-ipfs-examples)
113113
- [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md)
114+
- [Tutorials](https://proto.school)
114115

115116
## Contributing
116117

‎examples/browser-browserify/README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@
77
<h3 align="center"><b>js-ipfs with browserify</b></h3>
88

99
<p align="center">
10-
<b><i>Bundle js-ipfs with Browserify!</i></b>
11-
<br />
12-
<br />
13-
<img src="https://raw.githubusercontent.com/jlord/forkngo/gh-pages/badges/cobalt.png" width="200">
14-
<br>
15-
<a href="https://github.com/ipfs/js-ipfs/tree/master/docs">Explore the docs</a>
16-
·
17-
<a href="https://codesandbox.io/">View Demo</a>
18-
·
19-
<a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Report Bug</a>
20-
·
21-
<a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Request Feature/Example</a>
22-
</p>
10+
<b><i>Bundle js-ipfs with Browserify!</i></b>
11+
<br />
12+
<br />
13+
<img src="https://raw.githubusercontent.com/jlord/forkngo/gh-pages/badges/cobalt.png" width="200">
14+
<br>
15+
<a href="https://github.com/ipfs/js-ipfs/tree/master/docs">Explore the docs</a>
16+
·
17+
<a href="https://codesandbox.io/">View Demo</a>
18+
·
19+
<a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Report Bug</a>
20+
·
21+
<a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Request Feature/Example</a>
22+
</p>
2323

2424
## Table of Contents
2525

@@ -36,7 +36,7 @@
3636
## About The Project
3737

3838
- Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs)
39-
- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser
39+
- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser
4040
- Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node
4141
- Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it
4242
- Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs
@@ -79,8 +79,9 @@ _For more examples, please refer to the [Documentation](#documentation)_
7979

8080
- [Config](https://docs.ipfs.io/)
8181
- [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api)
82-
- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples)
82+
- [Examples](https://github.com/ipfs-examples/js-ipfs-examples)
8383
- [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md)
84+
- [Tutorials](https://proto.school)
8485

8586
## Contributing
8687

‎examples/browser-create-react-app/README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@
77
<h3 align="center"><b>IPFS React App</b></h3>
88

99
<p align="center">
10-
<b><i>Using js-ipfs in a `create-react-app`</i></b>
11-
<br />
12-
<br />
13-
<img src="https://raw.githubusercontent.com/jlord/forkngo/gh-pages/badges/cobalt.png" width="200">
14-
<br>
15-
<a href="https://github.com/ipfs/js-ipfs/tree/master/docs">Explore the docs</a>
16-
·
17-
<a href="https://codesandbox.io/">View Demo</a>
18-
·
19-
<a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Report Bug</a>
20-
·
21-
<a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Request Feature/Example</a>
22-
</p>
10+
<b><i>Using js-ipfs in a `create-react-app`</i></b>
11+
<br />
12+
<br />
13+
<img src="https://raw.githubusercontent.com/jlord/forkngo/gh-pages/badges/cobalt.png" width="200">
14+
<br>
15+
<a href="https://github.com/ipfs/js-ipfs/tree/master/docs">Explore the docs</a>
16+
·
17+
<a href="https://codesandbox.io/">View Demo</a>
18+
·
19+
<a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Report Bug</a>
20+
·
21+
<a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Request Feature/Example</a>
22+
</p>
2323

2424
## Table of Contents
2525

@@ -40,7 +40,7 @@
4040
## About The Project
4141

4242
- Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs)
43-
- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser
43+
- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser
4444
- Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node
4545
- Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it
4646
- Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs
@@ -119,8 +119,9 @@ _For more examples, please refer to the [Documentation](#documentation)_
119119

120120
- [Config](https://docs.ipfs.io/)
121121
- [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api)
122-
- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples)
122+
- [Examples](https://github.com/ipfs-examples/js-ipfs-examples)
123123
- [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md)
124+
- [Tutorials](https://proto.school)
124125

125126
## Contributing
126127

‎examples/browser-exchange-files/README.md

Lines changed: 34 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -7,45 +7,44 @@
77
<h3 align="center"><b>Exchange files with js-ipfs</b></h3>
88

99
<p align="center">
10-
<b><i>Exchange files between the browser and other IPFS nodes</i></b>
11-
<br />
12-
<br />
13-
<img src="https://raw.githubusercontent.com/jlord/forkngo/gh-pages/badges/cobalt.png" width="200">
14-
<br>
15-
<a href="https://github.com/ipfs/js-ipfs/tree/master/docs">Explore the docs</a>
16-
·
17-
<a href="https://codesandbox.io/">View Demo</a>
18-
·
19-
<a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Report Bug</a>
20-
·
21-
<a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Request Feature/Example</a>
22-
</p>
10+
<b><i>Exchange files between the browser and other IPFS nodes</i></b>
11+
<br />
12+
<br />
13+
<img src="https://raw.githubusercontent.com/jlord/forkngo/gh-pages/badges/cobalt.png" width="200">
14+
<br>
15+
<a href="https://github.com/ipfs/js-ipfs/tree/master/docs">Explore the docs</a>
16+
·
17+
<a href="https://codesandbox.io/">View Demo</a>
18+
·
19+
<a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Report Bug</a>
20+
·
21+
<a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Request Feature/Example</a>
22+
</p>
2323

2424
## Table of Contents
2525

26-
- [](#)
27-
- [Table of Contents](#table-of-contents)
28-
- [About The Project](#about-the-project)
29-
- [Getting Started](#getting-started)
30-
- [Pre requisites](#pre-requisites)
31-
- [Installation and Running example](#installation-and-running-example)
32-
- [Usage](#usage)
33-
- [Step-by-step instructions](#step-by-step-instructions)
34-
- [1. Install `go-ipfs` or `js-ipfs`](#1-install-go-ipfs-or-js-ipfs)
35-
- [2. Make your daemons listen on WebSockets](#2-make-your-daemons-listen-on-websockets)
36-
- [3. Start the app](#3-start-the-app)
37-
- [4. Dial to a node using WebSockets (your desktop ones)](#4-dial-to-a-node-using-websockets-your-desktop-ones)
38-
- [5. Transfer files between all of your nodes!](#5-transfer-files-between-all-of-your-nodes)
39-
- [Going to production?](#going-to-production)
40-
- [Use your own `libp2p-webrtc-star` signaling server](#use-your-own-libp2p-webrtc-star-signaling-server)
41-
- [Documentation](#documentation)
42-
- [Contributing](#contributing)
43-
- [Want to hack on IPFS?](#want-to-hack-on-ipfs)
26+
- [Table of Contents](#table-of-contents)
27+
- [About The Project](#about-the-project)
28+
- [Getting Started](#getting-started)
29+
- [Pre requisites](#pre-requisites)
30+
- [Installation and Running example](#installation-and-running-example)
31+
- [Usage](#usage)
32+
- [Step-by-step instructions](#step-by-step-instructions)
33+
- [1. Install `go-ipfs` or `js-ipfs`](#1-install-go-ipfs-or-js-ipfs)
34+
- [2. Make your daemons listen on WebSockets](#2-make-your-daemons-listen-on-websockets)
35+
- [3. Start the app](#3-start-the-app)
36+
- [4. Dial to a node using WebSockets (your desktop ones)](#4-dial-to-a-node-using-websockets-your-desktop-ones)
37+
- [5. Transfer files between all of your nodes!](#5-transfer-files-between-all-of-your-nodes)
38+
- [Going to production?](#going-to-production)
39+
- [Use your own `libp2p-webrtc-star` signaling server](#use-your-own-libp2p-webrtc-star-signaling-server)
40+
- [Documentation](#documentation)
41+
- [Contributing](#contributing)
42+
- [Want to hack on IPFS?](#want-to-hack-on-ipfs)
4443

4544
## About The Project
4645

4746
- Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs)
48-
- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser
47+
- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser
4948
- Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node
5049
- Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it
5150
- Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs
@@ -192,12 +191,10 @@ Check the `/ws` in line 5, that means it is listening. Cool.
192191

193192
### 3. Start the app
194193

195-
Make sure you're in `js-ipfs/examples/exchange-files-in-browser`.
196-
197194
We'll need to bundle the dependencies to run the app. Let's do it:
198195

199196
```sh
200-
> npm run bundle
197+
> npm run build
201198
...
202199
> npm start
203200
```
@@ -293,8 +290,9 @@ You should add your signaling server in the IPFS config swarm addresses, so that
293290

294291
- [Config](https://docs.ipfs.io/)
295292
- [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api)
296-
- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples)
293+
- [Examples](https://github.com/ipfs-examples/js-ipfs-examples)
297294
- [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md)
295+
- [Tutorials](https://proto.school)
298296

299297
## Contributing
300298

0 commit comments

Comments
 (0)