README.md

Using Helia inside a NestJS app

Explore the docs · Report Bug · Request Feature/Example

About

This is an example of how to run Helia in a NestJS application.

This demo was created by running the nest new command to bootstrap a basic project.

A few changes to the default project config were necessary:

1. Ensure TypeScript outputs ESM and not CJS
   • Please see the helia-typescript example for more information
2. Ensure Jest can run TypeScript ESM tests
   • Please see the helia-jest-typescript example for more information

Getting Started

Prerequisites

https://github.com/ipfs-examples/helia-examples#prerequisites

Installation and Running example

> npm install
> npm start

Now open your browser at http://localhost:3000

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.

Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.

You will also see any lint errors in the console.

npm run build

Builds the app for production to the dist folder.

It correctly bundles in production mode and optimizes the build for the best performance.

npm test

Runs the Jest unit test suite.

npm run test:e2e

Runs the Jest end-to-end test suite.

Usage

This is a NestJS project bootstrapped with nest new $project_name integrated with helia.

You can start editing the app by modifying src/main.js.

Learn More

To learn more about NestJS, take a look at the following resources:

• NestJS Documentation - learn about NestJS features and API.

Documentation

• IPFS Primer
• IPFS Docs
• Tutorials
• More examples
• API - Helia
• API - @helia/unixfs

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?

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 and JavaScript Contributing Guidelines.

• Check out existing issues The issue list has many that are marked as 'help wanted' or 'difficulty:easy' which make great starting points for development, many of which can be tackled with no prior IPFS knowledge
• Look at the Helia Roadmap 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