Skip to content

Commit

Permalink
Rename examples; Initial commit for README update & refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
donald-stolz committed May 3, 2020
1 parent 536c3f5 commit b0271f7
Show file tree
Hide file tree
Showing 234 changed files with 62 additions and 24 deletions.
80 changes: 56 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,28 @@
</a>
</p>
<h1 align="center">
Basics for Decentralized Websites
Decentralized Websites
</h1>

**Repository for sharing templates and decentralized website info**
<!-- TODO: Improve & lengthen description -->

## Deploy an IPFS site
> Repository for sharing templates and decentralized website info
> **[Join Our Community on Telegram](https://t.me/joinchat/FNyCe0oURg3dm10M7i3Zjg)**
1. Checkout the [examples](examples/) to find and update a template that you like.
2. Once you've finished with your site, you can deploy to [pinata](https://pinata.cloud/) by using our deploy script or another IPFS tool like [ipfs-deploy](https://github.com/ipfs-shipyard/ipfs-deploy)
3. Once you've gotten your IPFS hash [attach it to your domain](https://youtu.be/I9vTeAtELOk?t=61)
4. Find your site on [ViewBlock](https://viewblock.io/) or check it out in our [demo browser](https://unstoppabledomains.com/browser)
## Table of Contents

- [Contributing](#contributing)
- [Build A Site](#build-a-site)
- [Templates](#templates)
- [JS Framework Examples](#js-framework-examples)
- [Deploy Site](#deploy-site)
- [Set up an automatic update](#set-up-an-automatic-update)
- [Additional Tools & Resources](#additional-tools---resources)
- [3rd Party Libraries](#3rd-party-libraries)
- [Decentralized Databases](#decentralized-databases)
- [IPFS Information](#ipfs-information)
- [Pinning Services](#pinning-services)
- [Blockchain Domains](#unstoppable-domains)

## Contributing

Expand All @@ -30,33 +41,54 @@ To add a new template simply fork this repo, add your templates into [examples/c
**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.

## Additional Articles & Resources
## Build A Site

**[Join Our Community on Telegram](https://t.me/joinchat/FNyCe0oURg3dm10M7i3Zjg)**
### Templates

**Tutorials**
### JS Framework Examples

- [How to Easily Host a Website on IPFS](https://medium.com/pinata/how-to-easily-host-a-website-on-ipfs-9d842b5d6a01)
## Deploy Site

**Additional Information**
1. Checkout the [examples](examples/) to find and update a template that you like.
2. Once you've finished with your site, you can deploy to [pinata](https://pinata.cloud/) by using our deploy script or another IPFS tool like [ipfs-deploy](https://github.com/ipfs-shipyard/ipfs-deploy)
3. Once you've gotten your IPFS hash [attach it to your domain](https://youtu.be/I9vTeAtELOk?t=61)
4. Find your site on [ViewBlock](https://viewblock.io/) or check it out in our [demo browser](https://unstoppabledomains.com/browser)

- [IPFS Homepage](https://ipfs.io/)
- [Github Repo](https://github.com/ipfs/ipfs)
- [IPFS Video Explaination](https://www.youtube.com/watch?v=5Uj6uR3fp-U)
- [How to Easily Host a Website on IPFS](https://medium.com/pinata/how-to-easily-host-a-website-on-ipfs-9d842b5d6a01)

- [What are Blockchain Domains?](https://community.unstoppabledomains.com/t/blockchain-domains-starter-guide-what-are-blockchain-domains/109)
### Set up an automatic update

- [Unstoppable Website Builder Guide](https://community.unstoppabledomains.com/t/website-builder-guide/446)
- [DApps Delivery Guide](https://dapps-delivery-guide.readthedocs.io/)
- [CNS - Github Pipeline](https://dapps-delivery-guide.readthedocs.io/en/latest/domain/cns.html#setup-pipeline-with-crypto-update)

**Other Tools & Projects**
## Additional Tools & Resources

### 3rd Party Libraries

- [Awesome IPFS](https://awesome.ipfs.io/)
- [Github Repo](https://github.com/ipfs/awesome-ipfs#awesome-ipfs-)
- [Pinata - IPFS pinning service](https://pinata.cloud/)
- [3Box - decentralized user data storage system](https://3box.io/)
<!-- TODO -->
- [Unlock - Membership protocol](https://github.com/unlock-protocol/unlock)
- [Origin Protocol - Blockchain-powered commerce](https://github.com/OriginProtocol/origin)

### Decentralized Databases

- [Orbit DB - Peer-to-Peer Databases for the Decentralized Web](https://github.com/orbitdb)
- [GUN - A realtime, decentralized, offline-first, graph protocol to sync the web](https://github.com/amark/gun)
- [DApps Delivery Guide](https://dapps-delivery-guide.readthedocs.io/)
- [CNS - Github Pipeline](https://dapps-delivery-guide.readthedocs.io/en/latest/domain/cns.html#setup-pipeline-with-crypto-update)

### IPFS Information

- [IPFS Homepage](https://ipfs.io/)
- [Github Repo](https://github.com/ipfs/ipfs)
- [IPFS Video Explaination](https://www.youtube.com/watch?v=5Uj6uR3fp-U)
- [Awesome IPFS](https://awesome.ipfs.io/)
- [Github Repo](https://github.com/ipfs/awesome-ipfs#awesome-ipfs-)

### Pinning Services

- [Pinata - IPFS pinning service](https://pinata.cloud/)

### Blockchain Domains

<!-- TODO extension & browser -->

- [What are Blockchain Domains?](https://community.unstoppabledomains.com/t/blockchain-domains-starter-guide-what-are-blockchain-domains/109)
- [Website Builder Guide](https://community.unstoppabledomains.com/t/website-builder-guide/446)
File renamed without changes.
File renamed without changes.
6 changes: 6 additions & 0 deletions examples/README.md → tREADME.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,9 @@ Check out [this article](https://medium.com/pinata/how-to-easily-host-a-website-

- [Guarda Donate Button](./web3-ui-components/guarda-donate-button)
- [MetaMask Tip Button](https://github.com/MetaMask/TipButton)

## Crypto Related Widgets

- [FXEmpire News Feed](https://www.fxempire.com/widgets/newsfeed)
- [CryptoCompare Widgets](https://www.cryptocompare.com/dev/widget/wizard)
- [Cryptonator](https://www.cryptonator.com/widget)
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.

0 comments on commit b0271f7

Please sign in to comment.