Skip to content

Commit

Permalink
Merge pull request #279 from dappnode/dapplion/main-readme
Browse files Browse the repository at this point in the history
Update main readme
  • Loading branch information
dapplion authored Mar 5, 2021
2 parents 01c4b26 + 268c8db commit 8b93447
Show file tree
Hide file tree
Showing 4 changed files with 90 additions and 136 deletions.
152 changes: 90 additions & 62 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,123 @@
# DAppNode

[![Website dappnode.io](https://img.shields.io/badge/Website-dappnode.io-brightgreen.svg)](https://dappnode.io/)
[![Documentation Wiki](https://img.shields.io/badge/Documentation-Wiki-brightgreen.svg)](https://github.com/dappnode/DAppNode/wiki)
[![Documentation Wiki](https://img.shields.io/badge/Documentation-Wiki-brightgreen.svg)](https://docs.dappnode.io)
[![GIVETH Campaign](https://img.shields.io/badge/GIVETH-Campaign-1e083c.svg)](https://beta.giveth.io/campaigns/5b44b198647f33526e67c262)
![GitHub All Releases](https://img.shields.io/github/downloads/dappnode/DAppNode/total.svg)
[![Twitter Follow](https://img.shields.io/twitter/follow/espadrine.svg?style=social&label=Follow)](https://twitter.com/DAppNODE?lang=es)

[![](https://github.com/dappnode/DAppNode/raw/master/doc/DAppNodeLogoWide.png)](https://github.com/dappnode/DAppNode/wiki/DAppNode-Installation-Guide)

<br/>
<p align="center">
<a href="https://github.com/dappnode/DAppNode/wiki/DAppNode-Installation-Guide">
<img width="300" height="87" src="https://github.com/dappnode/DAppNode/raw/master/doc/DappnodeInstall.png">
<a href="https://dappnode.io/">
<img width="800" src="doc/DAppNodeLogoWide-outlined.png">
</a>
</p>

<br/>
<p align="center">
<a href="https://install.dappnode.io">
<img width="200" src="doc/DappnodeInstall.png">
</a>
</p>
<br/>

What happens when you want to use a Decentralized P2P network, but securing your own nodes takes a lot of time and effort?

You have a decentralization bottleneck at the entry point, which is where we are now in the blockchain space :-(

1. At no point in the last 2 years has there been more than 13,000 Bitcoin nodes online and that number got as low as [5500](https://bitnodes.earn.com/dashboard/?days=730)
### Infrastructure for the decentralized world

2. MetaMask and MyEtherWallet/MyCrypto are the primary wallets used on Ethereum and most users are using these wallets’ default nodes… This is a huge centralizing force in Ethereum.
DAppNode is empowering people by creating a simple, transparent system for hosting P2P clients for DApps, Cryptocurrencies, VPNs, IPFS and more

3. The people who do run their own node end up [having to spend a lot of time troubleshooting](https://www.reddit.com/r/ethereum/comments/83a34l/centralization_in_ethereum_infura_metamask/), keeping it updated and synced without the ability to easily share their node (and efforts) with family and friends.
- Read about our purpose and mission https://dappnode.io/
- Join our community https://discord.gg/c28an8dA5k
- Check out what we are delivering https://medium.com/dappnode
- Share your ideas and support from us https://discourse.dappnode.io/

DAppNode will address these issues by creating a simple, easy, self-empowering system made specifically for hosting P2P clients for DApps, Cryptocurrencies, VPNs, IPFS, and more.
# Discover DAppNode

Members of the [WHG](https://motherboard.vice.com/en_us/article/qvp5b3/how-ethereum-coders-hacked-back-to-rescue-dollar208-million-in-ethereum?lipi=urn%253Ali%253Apage%253Ad_flagship3_profile_view_base_treasury%253B7v09na8XQqySEuI%252FPn%252Bx5Q%253D%253D) have spent countless hours developing DAppNode because they believe it to be the most important and pertinent censorship resistant tool that is to be built to help bring the decentralized world everyone wants for themselves, and their friends and family.
DAppNode lowers the barrier of entry for non tech-savy participants. It allows you to deploy, update, and manage P2P clients and nodes without leaving your browser. No terminal or command line interface.

# The Desired Final User Story:
<p align="center">
<a href="https://install.dappnode.io">
<img width="800" src="doc/DAppNodeAdminUI-demo.png">
</a>
</p>

1. Vojtech has several cryptocurrencies he follows and is ready to stop using his laptop to run clients, but doesn’t want to have to pay a monthly subscription in fiat to some company he doesn’t trust with his private keys.
# Develop with DAppNode

2. He hears about DAppNode and decides to buy the top of the line DAppNode Server preloaded from shop.dappnode.io (though he could buy his own server and install the software himself).
DAppNode modular architecture allows any team to or project to publish a dockerized application to the DAppNode packages eco-system. Benefit from an enthusiatic crypto savy user based and offer a user interface-only experience to lower onboarding friction.

3. The DAppNode Server is delivered to his front door, and when Vojtech opens the box he finds a 2 step instruction card: First, plug in the Server. Second, go to welcome.dappnode.io.
Check out the [DAppNodeSDK](https://github.com/dappnode/DAppNodeSDK) to learn how to get started.

4. On this website there will be an extremely simple and short walk-thru for Vojtech to set up his credentials and choose which clients to deploy.
_Note: packages are published to Ethereum mainnet and incur costs. Given the current high gas prices the DAppNode team is willing to subsidize gas costs for packages of great interest to users._

5. By just checking a few boxes Vojtech deployed his own VPN; his own local instance of MyCrypto.com; Ethereum, Bitcoin, Monero and Dogecoin Full nodes; a Zcash Secure Node and DASH Master Node; he joined the IPFS Consortium and deployed a TrueBit Verifier and Livepeer node; and hosted Giveth, Swarm City, Aragon, Colony, and Decentraland Helper DApps to support these projects and to ensure that his interaction with these DApps cannot be censored and are fully trustless.
# Packages eco-system

6. Vojtech then tells his friends and family that he is the admin for his own DAppNode and he is able to give them a link that sets them up with their own credentials and access to his DAppNode, and Vojtech can deploy any other DApps that him or his friends and family want to have hosted with a couple clicks. He has become the trusted gateway to the decentralized world for his entire community.
The community and core team members have created many useful packages for users. Checkout the [**package explorer**](https://explorer.dappnode.io) to browse an up-to-date list of all packages and their versions.

7. Vojtech ends up being able to pay off the cost of his DAppNode in 2 months with the profits made from his ZenCash, Trustlines Validator, ETH2.0 validator, DASH and TrueBit Nodes. He also canceled his VPN and all of his Digital Ocean accounts because now he has his own server that he can host all of his services on. Without even trying, Vojtech has a couple extra hundred dollars a month because he is running DAppNode on his own personal server.
<p align="center">
<a href="https://explorer.dappnode.io">
<img width="600" src="doc/DAppNodeExplorer.png">
</a>
</p>

Though the above story is not ready yet, we are developing in an invitingly open source manner and anyone can use their own hardware and run DAppNode on it.
## Champions

Champions are community members that are in charge of maintaining packages updated. All packages in this list without a champions are actively looking for a champion. Join our [DAppNode Discord **#champion-process**](https://discord.gg/MhSPBsHryu) to suggest a package to be championed and/or offer to be a champion for a project you care about!

| Package | Champion |
| ---------------------------------------------------------------------------------------- | ---------------- |
| [Avalanche](https://github.com/Colm3na/DAppNodePackage-avalanche) | - |
| [ARTIS-sigma1](https://github.com/lab10-coop/DAppNodePackage-ARTIS-sigma1) | - |
| [Bee](https://github.com/dappnode/DAppNodePackage-bee) | @tropicar |
| [Bitcoin](https://github.com/dappnode/DAppNodePackage-bitcoin) | @Pol-Lanski |
| [Block-explorer](https://github.com/dappnode/DappnodePackage-block-explorer) | - |
| [Cosmos](https://github.com/Colm3na/DAppNodePackage-cosmos) | - |
| [DMS](https://github.com/dappnode/DAppNodePackage-DMS) | - |
| [Eth2stats-client](https://github.com/dappnode/DAppNodePackage-eth2stats-client) | - |
| [Ethereum Classic](https://github.com/dappnode/DAppNodePackage-ethereum-classic) | - |
| [Ethereum Optimism](https://github.com/dappnode/DAppNodePackage-ethereum-optimism) | - |
| [Exporter](https://github.com/dappnode/DAppNodePackage-exporter) | - |
| [Geth](https://github.com/dappnode/DAppNodePackage-geth) | - |
| [Goerli Geth](https://github.com/dappnode/DAppNodePackage-goerli-geth) | - |
| [Grin](https://github.com/dappnode/DAppNodePackage-grin) | - |
| [HTTPs Portal](https://github.com/dappnode/DAppNodePackage-https-portal) | - |
| [Ipfs Cluster](https://github.com/dappnode/DAppNodePackage-ipfs-cluster) | - |
| [Ipfs Pinner](https://github.com/dappnode/DAppNodePackage-ipfs-pinner) | - |
| [Kovan](https://github.com/dappnode/DAppNodePackage-kovan) | - |
| [LightningNetwork](https://github.com/dappnode/DAppNodePackage-LightningNetwork) | @pablomendezroyo |
| [Matrix](https://github.com/dappnode/DAppNodePackage-matrix) | - |
| [Metrics Tools](https://github.com/dappnode/DAppNodePackage-metrics-tools) | - |
| [Monero](https://github.com/dappnode/DAppNodePackage-monero) | @pablomendezroyo |
| [Nethermind](https://github.com/dappnode/DAppNodePackage-nethermind) | - |
| [Openethereum](https://github.com/dappnode/DAppNodePackage-openethereum) | - |
| [Owncloud](https://github.com/dappnode/DAppNodePackage-owncloud) | - |
| Polkadot Kusama | @tropicar |
| [Prysm](https://github.com/dappnode/DAppNodePackage-prysm) | @pablomendezroyo |
| [Prysm Pyrmont](https://github.com/dappnode/DAppNodePackage-prysm-pyrmont) | @pablomendezroyo |
| [Raiden](https://github.com/dappnode/DAppNodePackage-raiden) | - |
| [Raiden Testnet](https://github.com/dappnode/DAppnodePackage-raiden-testnet) | - |
| [Rinkeby](https://github.com/dappnode/DAppNodePackage-rinkeby) | - |
| [Ropsten](https://github.com/dappnode/DAppNodePackage-ropsten) | - |
| [Storj](https://github.com/dappnode/DAppNodePackage-storj) | @pablomendezroyo |
| [Tornado Cash Relayer](https://github.com/dappnode/DAppNodePackage-Tornado-Cash-Relayer) | - |
| [Trustlines](https://github.com/dappnode/DAppNodePackage-trustlines) | - |
| [Trustlines bridge](https://github.com/dappnode/DAppNodePackage-trustlines-bridge) | - |
| [Trustlines monitor](https://github.com/dappnode/DAppNodePackage-trustlines-monitor) | - |
| [Trustlines netstats](https://github.com/dappnode/DAppNodePackage-trustlines-netstats) | - |
| [Trustlines validator](https://github.com/dappnode/DAppNodePackage-trustlines-validator) | - |
| [Turbo-geth](https://github.com/dappnode/DAppNodePackage-turbo-geth) | - |
| [Vipnode](https://github.com/dappnode/DAppNodePackage-vipnode) | - |
| [Wireguard](https://github.com/dappnode/DAppNodePackage-wireguard) | - |
| [ZCash](https://github.com/dappnode/DAppNodePackage-zcash) | - |

# Core packages

We are open to receive funding to help pay the developers working hard on the software!
- [DNP_DAPPMANAGER](https://github.com/dappnode/DNP_DAPPMANAGER)
- [DNP_VPN](https://github.com/dappnode/DNP_VPN)
- [DNP_IPFS](https://github.com/dappnode/DNP_IPFS)
- [DNP_BIND](https://github.com/dappnode/DNP_BIND)

# Team members

Members of the [White Hat Group (WHG)](https://motherboard.vice.com/en_us/article/qvp5b3/how-ethereum-coders-hacked-back-to-rescue-dollar208-million-in-ethereum) have spent countless hours boostraping and developing DAppNode in 2017. Currently, the project is mantained by a growing multi-disciplary team:

- **Adviser & Instigator:** Jordi Baylina
- **Project Lead:** Eduadiez
- **Developer Lead:** dapplion
Expand All @@ -61,43 +126,6 @@ We are open to receive funding to help pay the developers working hard on the so
- **Developer:** Carlos
- **Adviser:** Griff Green

# Where the DAppers play

[DAppNode](https://dappnode.io/)

[Discourse](https://discourse.dappnode.io/)

[Github](https://github.com/dappnode/DAppNode/wiki/DAppNode-Installation-Guide)

# **Benefits of DAppNode**

- Easy set up
- Trustless system
- Invitingly Open Source
- Free up space on your Devices
- Great for Proof of Stake mining
- You can browse `.eth` domains like the normal web
- You take control of your Nodes
- Encourages people to have their own server
- Perfect for projects that reward you for hosting, (Filecoin, Storj, etc)
- Can facilitate a P2P economy
- Host any P2P networking protocols
- DApp teams can develop packages their users can run 24x7
- Never trust a hosting provider with your private keys again!
- One click node deployment (Full Nodes, DApps)
- Censorship resistance (run your own VPN)
- 1 DAppNode can support an entire Community
- DAppNode will build communities and decrease centralization
- DAppNode is the most important piece of infrastructure for our decentralized future
- Considering all of the incentive structures to run nodes, most DAppNode Admins will be make a profit maintaining their own DAppNode

# Core repos

- [DNP_DAPPMANAGER](https://github.com/dappnode/DNP_DAPPMANAGER)
- [DNP_VPN](https://github.com/dappnode/DNP_VPN)
- [DNP_IPFS](https://github.com/dappnode/DNP_IPFS)
- [DNP_BIND](https://github.com/dappnode/DNP_BIND)

## License

This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details
Binary file added doc/DAppNodeAdminUI-demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/DAppNodeLogoWide-outlined.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 8b93447

Please sign in to comment.