Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ipfs-examples/helia-cjs

Using Helia from CommonJS
https://github.com/ipfs-examples/helia-cjs

Last synced: about 2 months ago
JSON representation

Using Helia from CommonJS

Host: GitHub
URL: https://github.com/ipfs-examples/helia-cjs
Owner: ipfs-examples
Created: 2023-02-03T13:06:31.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-02-08T13:50:51.000Z (11 months ago)
Last Synced: 2024-03-29T11:59:15.764Z (9 months ago)
Language: JavaScript
Homepage:
Size: 15.6 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        


  

    

  



Using Helia from CommonJS




  

  


  Explore the docs

  ·

  View Demo

  ·

  Report Bug

  ·

  Request Feature/Example



## Table of Contents

- [Table of Contents](#table-of-contents)

- [About The Project](#about-the-project)

- [Getting Started](#getting-started)

  - [Prerequisites](#prerequisites)

  - [Installation and Running example](#installation-and-running-example)

- [Usage](#usage)

- [Documentation](#documentation)

- [Contributing](#contributing)

- [Want to hack on IPFS?](#want-to-hack-on-ipfs)

## About The Project

- Read the [docs](https://ipfs.github.io/helia/modules/helia.html)

- Look into other [examples](https://github.com/ipfs-examples/helia-examples) to learn how to spawn a Helia node in Node.js and in the Browser

- Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it

- Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs

- Check out https://docs.ipfs.io for tips, how-tos and more

- See https://blog.ipfs.io for news and more

- Need help? Please ask 'How do I?' questions on https://discuss.ipfs.io

## Getting Started

### Prerequisites

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

- Git - [Download & Install Git](https://git-scm.com/downloads). OSX and Linux machines typically have this already installed.

- Node.js - [Download & Install Node.js](https://nodejs.org/en/download/) and the npm package manager.

### Installation and Running example

```console

> npm install

> npm start

```

## Usage

This tutorial is a port of [helia-101](https://github.com/ipfs-examples/helia-101) but the main file is [CommonJS](https://en.wikipedia.org/wiki/CommonJS) and not [ESM](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules).

If you are seeing errors like `ERR_REQUIRE_ESM` or `ERR_PACKAGE_PATH_NOT_EXPORTED` when trying to use Helia or other ESM modules from CJS, this is the example for you.

It consists of one file, `index.js` which is a CommonJS file that uses [dynamic imports](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import) to load an ESM module from CommonJS source code.

Everything else is the same as the [helia-101](https://github.com/ipfs-examples/helia-101) - please see that example for a full breakdown of the code.

_For more examples, please refer to the [Documentation](#documentation)_

## Documentation

- [IPFS Primer](https://dweb-primer.ipfs.io/)

- [IPFS Docs](https://docs.ipfs.io/)

- [Tutorials](https://proto.school)

- [More examples](https://github.com/ipfs-examples/helia-examples)

- [API - Helia](https://ipfs.github.io/helia/modules/helia.html)

- [API - @helia/unixfs](https://ipfs.github.io/helia-unixfs/modules/helia.html)

## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the IPFS Project

2. Create your Feature Branch (`git checkout -b feature/amazing-feature`)

3. Commit your Changes (`git commit -a -m 'feat: add some amazing feature'`)

4. Push to the Branch (`git push origin feature/amazing-feature`)

5. Open a Pull Request

## Want to hack on IPFS?

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

The IPFS implementation in JavaScript needs your help! There are a few things you can do right now to help out:

Read the [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md) and [JavaScript Contributing Guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md).

- **Check out existing issues** The [issue list](https://github.com/ipfs/helia/issues) has many that are marked as ['help wanted'](https://github.com/ipfs/helia/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22) or ['difficulty:easy'](https://github.com/ipfs/helia/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Adifficulty%3Aeasy) which make great starting points for development, many of which can be tackled with no prior IPFS knowledge

- **Look at the [Helia Roadmap](https://github.com/ipfs/helia/blob/main/ROADMAP.md)** This are the high priority items being worked on right now

- **Perform code reviews** More eyes will help

  a. speed the project along

  b. ensure quality, and

  c. reduce possible future bugs

- **Add tests**. There can never be enough tests

[cid]: https://docs.ipfs.tech/concepts/content-addressing  "Content Identifier"

[Uint8Array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array

[libp2p]: https://libp2p.io