Skip to content

Latest commit

 

History

History

helia-nextjs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
.github
.github
 
 
components
components
 
 
pages
pages
 
 
public
public
 
 
styles
styles
 
 
test
test
 
 
README.md
README.md
 
 
next.config.js
next.config.js
 
 
package.json
package.json
 
 

README.md

Helia logo

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

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

Usage

This is a Next.js project bootstrapped with 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 can be accessed on 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 instead of React pages.

Learn More

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

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

For more examples, please refer to the Documentation

Documentation

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