/ README.md
README.md
1 ## Decentralized Reddit dApp built using Embark by Status 2 Developed for a Mexico workshop, this dApp provides an example of how to build a dApp using Embark. 3 4 ### Instructions 5 To follow along, please use the [instructions](./instructions). 6 7 ### Notes for workshop instructor. 8 1. This dApp has less functionality than DTwitter, but includes a step for deploying the DApp to testnet, as well as a section to discuss voting mechanism when building the contract. 9 2. Recommended time: 1 - 1.5hr. 10 3. For the upload, it's recommended to have deployed the dApp before, and have a short link made using a service like [bit.ly](https://bit.ly). You need also an account that has Ropsten ether to deploy the contracts. 11 4. After uploading the dApp, access it via status. You can use Status Desktop, or your phone. If you use your phone, you can display its screen on your computer using an app like [Airdroid](https://www.airdroid.com/) (free, for Android) or [Reflector](http://www.airsquirrels.com/reflector/) (for both iOS and Android) 12 13 ### FAQ 14 1. Can I use `embark simulator`? 15 Yes, you can. You can even use `ganache-cli` directly if desired. We are not using for this dApp due to websockets limitations of ganache. 16 2. Do we have some success stories of people using embark and delivering projects? 17 * The Status OKR voting app: https://github.com/status-im/contracts/tree/000-snt-voting-dapp 18 * Vortex demo using embark: https://github.com/Horyus/vortex-demo-embark/blob/master/package.json#L23-L35 19 * ERC-721 (collectibles) tutorial and demo app: https://github.com/status-im/embark-tutorial-erc721. Tutorial docs here: https://github.com/status-im/embark-tutorial-erc721/tree/tutorial-series/tutorial 20 3. Where can I learn more about the API of the EmbarkJS object? 21 * We are currently working on updating the docs, and additionally we are currently making EmbarkJS a library on its own right: https://github.com/embark-framework/EmbarkJS 22 4. What are the "key" features of Embark? 23 * Embark is focused on the trinity of web3 components that can be used to create truly decentralised applications 24 * The original trinity of web3, from the ethereum platform perspective, includes consensus, blockchain, and smart contracts. As well as swarm for decentralized storage and whisper for decentralized communication. 25 * Embark is a “true” dApp framework to assist the developer in building real dApps. Embark can also be used just for developing contracts as well. 26 * Embark is meant to help the developer easily integrate with other decentralized technologies, like storage, communication, and (in 3.2) naming systems. 27 * Embark is meant to be both advanced and easy to use 28 * Embark has reasonable defaults and tries to make your life easier, but it can always be overridden for configurable for your specific needs 29 * Embark has a very plugin-driven architecture, so developers can also extend it to their own needs 30 * Integrated debugger - we are currently working on this, and the developer can always use remix as an alternative 31 32 ### Known issues with this dApp 33 ##### Issues on localhost 34 1. Create account - hangs with metamask 35 * Cause - most likely non-increasing nonce issue with metamask: https://github.com/MetaMask/metamask-extension/issues/1999) 36 * Solution - open issue 37 38 ##### Issues on testnet (rinkeby) 39 1. Sometimes errors with the “known transaction” when deploying a contract. 40 * *Cause:* not yet known 41 * *Solution:* only solution so far is to increase the `gasPrice` in contracts -> testnet -> deployment. Embark team currently investigating. 42 2. Getting contract events (tweets in this case) doesn’t work 43 * *Cause:* Metamask known issue “The current provider doesn’t support subscriptions: MetamaskInpageProvider” 44 * *Solution:* open issue 45 3. Websockets errors 46 * *Cause:* known issue with metamask: https://github.com/MetaMask/metamask-extension/issues/1645) 47 * *Solution:* open issue