Giter VIP home page Giter VIP logo

create-ipfs-app's Introduction

Create IPFS App

Create IPFS App

IPFS

Create IPFS apps with no build configuration (like create-react-app).

FileBase.Com Web3.Storage Pinata.Cloud Moralis.Io

Create IPFS App works on macOS, Windows, and Linux.
If something doesn’t work, please file an issue.
If you have questions or need help, please ask in GitHub Discussions.
If you want to watch the tutorial, go to this video.

Quick Overview

To create a new IPFS app, you may choose one of the following methods:

NPX

npx create-ipfs-app my-ipfs-app --web3 WEB3_STORAGE_API_TOKEN

YARN

yarn create ipfs-app my-ipfs-app --moralis MORALIS_WEB3_API_KEY

NPM

npm install -g create-ipfs-app
create-ipfs-app my-ipfs-app --pinata PINATA_API_KEY:PINATA_API_SECRET

Params

  • --web3 WEB3_STORAGE_API_TOKEN
  • --moralis MORALIS_WEB3_API_KEY
  • --pinata PINATA_API_KEY:PINATA_API_SECRET
  • --filebase FILEBASE_API_KEY:FILEBASE_API_SECRET:FILEBASE_BUCKET_NAME

Create IPFS App Success

Once the installation is done, you can open your project folder:

cd my-ipfs-app

Inside the newly created project, you can run some built-in commands:

npm start or yarn start

Runs the app in development mode.
Open http://localhost:3000 to view it in the browser.

npm test or yarn test

Runs the test watcher in an interactive mode.
By default, runs tests related to files changed since the last commit.

npm run build or yarn build

Builds the app for production to the build folder.
Your app is ready to be deployed.

npm run deploy:service or yarn deploy:service

Create IPFS App Deployed

In a few seconds, your application will be deployed on the decentralized network.

  • Open ipfs://Q.../index.html to view it in the Brave browser.
  • Open https://dweb.link/ipfs/Q.../index.html to view it in the ALL browsers.

If you see a white screen instead of a website:

  • Add to package.json "homepage": ".";
  • Build the project;
  • Deploy it again.

How to add a deployment script to an existing project?

  • Install global package ipfs-scripts;
  • Create .env file at the root of project:
    • MORALIS="MORALIS.IO WEB3_API_KEY"
    • PINATA="PINATA.CLOUD API_KEY:API_SECRET"
    • WEB3="WEB3.STORAGE API_TOKEN"
    • FILEBASE="FILEBASE.COM API_KEY:API_SECRET:BUCKET_NAME"
  • Add scripts to package.json:
    • "deploy:moralis": "ipfs-scripts moralis"
    • "deploy:pinata": "ipfs-scripts pinata"
    • "deploy:web3": "ipfs-scripts web3"
    • "deploy:filebase": "ipfs-scripts filebase"

TODO

  • web3.storage
  • moralis.io
  • pinata.cloud
  • filebase.com
  • framework agnostic (vue, svelte, ...)
  • auto-update CloudFlare DNS

create-ipfs-app's People

Contributors

alexbakers avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.