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-nextjs

Using Helia with nextjs
https://github.com/ipfs-examples/helia-nextjs

Last synced: about 2 months ago
JSON representation

Using Helia with nextjs

Host: GitHub
URL: https://github.com/ipfs-examples/helia-nextjs
Owner: ipfs-examples
Created: 2023-04-04T16:59:19.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-02-08T13:50:57.000Z (11 months ago)
Last Synced: 2024-03-29T11:59:16.087Z (9 months ago)
Language: JavaScript
Homepage:
Size: 20.5 KB
Stars: 0
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        


  

    

  



Using Helia inside a Next.js app




  

  


  Explore the docs

  ·

  View Demo

  ·

  Report Bug

  ·

  Request Feature/Example



## Table of Contents

See https://github.com/ipfs-examples/helia-examples#table-of-contents for more information about Helia examples.

## Getting Started

### Prerequisites

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

### Installation and Running example

```console

> 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](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.

## Usage

This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) integrated with `helia`.

You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.

[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.

The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.

### Learn More

To learn more about Next.js, take a look at the following resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.

- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!

### Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

_For more examples, please refer to the [Documentation](https://github.com/ipfs-examples/helia-examples#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