549-Project - Personal Dex Blog

A decentralised, unstoppable, privacy-by-design and censor-proof blog

Pre-requisites

node v10.20.1 
npm v6.14.4

Browser extensions

Metamask (or Brave Browser)
Unstoppable Domains
IPFS Companion

Environment setup

$ npm install
(optional) $ npm audit fix 
$ npx openzeppelin init
$ cp secrets.json-sample secrets.json

Smart-contract compile and deploy

Open another window

$ npx ganache-cli --deterministic

Return to the previous window Note the mnemonic and update secrets.json

$ npx oz compile
$ npx oz deploy

Regular > Development > DocRegisterHash

Take a note of the smart-contract address (i.e: 0xe78A0F7E598Cc8b0Bb87894B0F60dD2a88d6a8Ab)

Configure project files with smart-contract address

Update the smart-contract address on 3 places:

• on src/blog/js/dxblog.js
  • update var contractAddress = '<your smart-contract address>'
• on src/ipfs-uploader/549.js
  • update var ganacheContractAddress = '<your smart-contract address>'
• on src/md-reader/lib/dxblog.js
  • update var contractAddress = '<your smart-contract address>'

IPFS Setup

Install ipfs browser extension: IPFS Companion

• https://chrome.google.com/webstore/detail/ipfs-companion/nibjojkomfdiaoajekhjakgkdhaomnch

Configure project files to IPFS

Post Uploader

on src/ipfs-uploader/549.js update

var ipfsHost = '<host>'; // default localhost
var ipfsPort = '<port>'; // default port 5001

Open IPFS dashboard: On browser extension, open Web-UI > Files Click on +Add > Folder and upload the entire folder ipfs-uploader Right-click over the uploaded folder, select Share > Copy then open a new tab with the address:

• it should open 549 IPFS File Uploader page.

Template/Markdown Reader

Open IPFS dashboard: On browser extension, open Web-UI > Files Click on +Add > Folder and upload the entire folder md-reader

a) Right-click over the uploaded folder, select Share > Copy then open a new tab with the address:

• it should open eddieoz.crypto page.
  • after publishing your own blog homepage, you can change the default address on index.html

b)Right-click over the uploaded folder, select Share > Copy Hash then open a new tab with the address

• on src/md-reader/lib/dxblog.js
  • update https://gateway.ipfs.io/ipfs/<ipfs hash>#/ipfs/ with your own hash
• on src/blog/js/dxblog.js
  • update https://gateway.ipfs.io/ipfs/<ipfs hash>#/ipfs/ with your own hash (yes, sometimes it is recursive)

Homepage

Open IPFS dashboard: On browser extension, open Web-UI > Files Click on +Add > Folder and upload the entire folder blog

a) Right-click over the uploaded folder, select Share > Copy then open a new tab with the address:

• it should open your homepage page.
  • after publishing your own blog homepage, you can change the default address on md-reader index.html

Live Demo

https://eddieoz.crypto (needs 'unstoppable extension' or Opera mobile)

Reference:

• https://web3js.readthedocs.io/en/v1.2.7
• https://docs.ipfs.io/guides/guides/addressing/
• https://docs.openzeppelin.com/
• https://github.com/unstoppabledomains/
• https://ethereum.stackexchange.com/questions/68947/uploading-files-on-ipfs-infura
• https://ipfs.io/docs/examples/markdown-viewer/
• https://jacksonng.org/ipfs-smart-contract

---

MIT License

Copyright (c) 2020 Edilson Osorio Jr

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.