Skip to content

Latest commit

 

History

History
148 lines (108 loc) · 8.15 KB

README.md

File metadata and controls

148 lines (108 loc) · 8.15 KB

Decentralized Websites

This repository is for sharing information about building decentralized websites. It contains starter templates and resources for deploying websites to IPFS. The goal of this repository is to contribute examples for building all types of decentralized websites and to maintain an up-to-date list of resources for decentralized web development.

Join Our Developer Community on Discord

Table of Contents

Contributing

Bounty Announcment

Add your template
We'd love to make your templates available on Unstoppable Domains' website builder. To add a new template simply fork this repo, add your templates into templates/community, and submit a PR with your update.

  • Add comments to whatever text, styles, or images that should be customized
  • Make sure all relevant css & font files are included. Sites should be fully decentralized and not rely on any APIs for styles
  • Do not use any trademarked or copyrighted assets without permission. If you want to use it, you have to ensure that you have the legal right to do so. If applicable add a footer with any necessary accreditation
  • We encourage you to add an author signature to the footer of your template

Bug Report or Improvement:
To report a bug in a template or suggest an improvement to this repo simply go to issues and fill out the proper template.

Build A Site

Checkout our Website Builder tool to easily deploy a site to your blockchain domain

IPFS Community Templates

Author Template Available In Builder (y/n)
@aranhaagency Stellar n
@aranhaagency Stellar Simple n
@zzzaim Personal Minimalist y
@caseykey IPFS Music Player n
@inspireme6 Simple Portfolio y
@dsgriffin 4 Sale y
@verymanley Ambitious (opacity) n (pending)
@iguessitsokay Elipsis Portfolio n (pending)

Unstoppable Domains Templates

In the (templates/unstoppable-domains)[templates/unstoppable-domains] directory you will find all of the templates available on the Unstoppable Domains website builder feature. In the index.html files for each template directory you will find comments pointing to the items we use for updating in the website builder.

  • The inline CSS styles are the options available to update in the website builder
  • SVG Icons are inlined so that colors can be updated

JS Framework Examples

Hosting a website on IPFS is slightly different than hosting it on a web server out in the cloud. Your website may require a little bit of tweaking in order to properly be served on the IPFS network.

The important rules are:

  • All of the content for your website must be contained in one build folder, with an index.html file.
  • All links within your files should be relative links.

Check out this article by Matt Ober, CoFounder and CTO of Pinata

Deploy Your Site

  1. Checkout the examples to find and update a template that you like.
  2. Once you've finished with your site, you can deploy to pinata by using our deploy script or another IPFS tool like ipfs-deploy
  3. Once you've gotten your IPFS hash attach it to your domain
  4. Check out your site using our tools, Chrome Extension or Decentralized Browser. You can also find your site on ViewBlock.

Set up automatic domain updates

Additional Tools & Resources

3rd Party Libraries

  • 3Box - Decentralized user data storage system
  • DAOstack - Solutions to enable the creation of Decentralized Autonomous Organizations
  • Unlock - Membership protocol
  • Origin Protocol - Blockchain-powered commerce

Decentralized Databases

  • Orbit DB - Peer-to-Peer Databases for the Decentralized Web
  • Textile - A set of open source tools that provide a decentralized database, IPFS-based storage, content hosting, and more
  • GUN - A realtime, decentralized, offline-first, graph protocol to sync the web

IPFS Information

Pinning Services

Blockchain Domains

Web3 & Crypto UI Components