Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: create a list of examples #27

Merged
merged 6 commits into from
Apr 6, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@
- [Table of Contents](#table-of-contents)
- [About The Project](#about-the-project)
- [Getting Started](#getting-started)
- [Examples](#examples)
whizzzkid marked this conversation as resolved.
Show resolved Hide resolved
- [Basics](#basics)
- [Frameworks](#frameworks)
- [Bundlers](#bundlers)
- [Prerequisites](#prerequisites)
- [IPFS Tutorials at ProtoSchool](#ipfs-tutorials-at-protoschool)
- [Documentation](#documentation)
Expand All @@ -44,6 +48,28 @@

## Getting Started

### Examples

Feel free to jump directly into the examples, however going through the following sections will help build context and background knowledge.

#### Basics

- [Helia-101](/examples/helia-101/): Spawn a Helia node, add a file and cat the file
- [Helia CommonJS](/examples/helia-cjs/): Just like Helia-101, but with [CommonJS](https://en.wikipedia.org/wiki/CommonJS) instead of [ESM](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules)
- [Helia via CDNs](/examples/helia-script-tag/): A simple proof-of-concept to distributing and using helia using `<script>` tags

#### Frameworks

- [Helia with Electron](/examples/helia-electron/): Create an Electron app with helia
- [Helia with Next.js](/examples/helia-nextjs/): Create a Next.js app with helia
- [Helia with Vue](/examples/helia-vue/): Create a vue app with helia
- [Helia with Vite](/examples/helia-vite/): Create a react+vite app with helia

#### Bundlers

- [Helia with esbuild](/examples/helia-esbuild/): Bundle helia with esbuild
- [Helia with Webpack](/examples/helia-webpack/): Bundle helia with webpack

### Prerequisites

Make sure you have installed all of the following prerequisites on your development machine:
Expand Down