Added readme

wickstjo · wickstjo · commit 5c5be37b9879 · 2018-09-10T15:13:45.000+03:00
diff --git a/js/modules/mutable.js b/js/modules/mutable.js
@@ -67,7 +67,7 @@ function nuke_logs(files) {
          // DEFAULT HISTORY CONTENT
          var latestDefault = {
             "name": "1.0",
-            "hash": "QmfAUMMnn33mnBAZP84jyWn3NVwKRjG3KN1R92SX9SnJD2",
+            "hash": "QmajVZUfnV7ne7hnn8Jr968wWhKxn7HtsoJ8SWAM4aDnLR",
             "timestamp": unixTime()
          }
 
diff --git a/readme.md b/readme.md
@@ -0,0 +1,40 @@
+## Borrowed Tools/Functionality
+- [GO-IPFS](https://github.com/ipfs/go-ipfs)
+- [JS-IPFS-API](https://github.com/ipfs/js-ipfs-api)
+- [Truffle](https://github.com/trufflesuite/truffle)
+- [Ganache](https://github.com/trufflesuite/ganache-cli)
+- [jQuery](https://jquery.com/)
+
+- [NodeJS & NPM](https://nodejs.org/en/)
+- [Backported Monaco Editor by Tim Kendrick](https://github.com/timkendrick/vscode-monaco-editor)
+- [Buffer](https://www.npmjs.com/package/buffer)
+- [Browserify](https://www.npmjs.com/package/browserify)
+- [Moment](https://www.npmjs.com/package/moment)
+
+## Turn on necessary components & compile
+
+Turn on IPFS Daemon:
+> $ shell/daemon.sh
+
+Push temp dataset to IPFS Swarm:
+> $ shell/dataset.sh
+
+Fix "CORS" error:
+> [https://github.com/ipfs/js-ipfs-api#cors](https://github.com/ipfs/js-ipfs-api#cors)
+
+Turn on Local Blockchain:
+> $ shell/ganache.sh
+
+Compile/Deploy Smart Contracts:
+> $ shell/deploy.sh
+
+Compile project node modules:
+> $ shell/browserify.sh
+
+## Change default values
+
+Blockchain & IPFS address/port:
+> [js/setup.js @ row 2-4](https://github.com/wickstjo/ipfs/blob/master/js/setup.js#L2)
+
+Root IPFS directory:
+> [js/modules/mutable.js @ row 70](https://github.com/wickstjo/ipfs/blob/master/js/modules/mutable.js#L70)
diff --git a/shell/browserify.sh b/shell/browserify.sh
@@ -0,0 +1 @@
+browserify js/app.js > js/bundle.js
diff --git a/shell/daemon.sh b/shell/daemon.sh
@@ -0,0 +1 @@
+ipfs daemon
diff --git a/shell/dataset.sh b/shell/dataset.sh
@@ -0,0 +1,5 @@
+ipfs swarm peers
+ipfs add -r shell/dataset/
+echo ""
+echo "Publishing....."
+ipfs name publish QmajVZUfnV7ne7hnn8Jr968wWhKxn7HtsoJ8SWAM4aDnLR
diff --git a/shell/dataset/index.html b/shell/dataset/index.html
@@ -0,0 +1,3 @@
+<body>
+   Hello World!
+</body>
diff --git a/shell/dataset/js/app.js b/shell/dataset/js/app.js
@@ -0,0 +1 @@
+$('#test').html('testing');
diff --git a/shell/dataset/readme.txt b/shell/dataset/readme.txt
@@ -0,0 +1 @@
+text here
diff --git a/shell/deploy.sh b/shell/deploy.sh
@@ -1,3 +1,5 @@
 rm -rf ../build/contracts/
 truffle migrate ../
-#truffle console
+
+# truffle console
+# Main.deployed().then(function(instance) { app = instance })
diff --git a/shell/ganache.sh b/shell/ganache.sh
@@ -0,0 +1 @@
+ganache-cli
diff --git a/shell/push-repo.sh b/shell/push-repo.sh
@@ -1,5 +1,6 @@
 echo Commit message?
 read msg
+echo ""
 git add -A
 git commit -m "$msg"
 git push origin master

Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ function nuke_logs(files) {`
`67`	`67`	`// DEFAULT HISTORY CONTENT`
`68`	`68`	`var latestDefault = {`
`69`	`69`	`"name": "1.0",`
`70`		`- "hash": "QmfAUMMnn33mnBAZP84jyWn3NVwKRjG3KN1R92SX9SnJD2",`
	`70`	`+ "hash": "QmajVZUfnV7ne7hnn8Jr968wWhKxn7HtsoJ8SWAM4aDnLR",`
`71`	`71`	`"timestamp": unixTime()`
`72`	`72`	`}`
`73`	`73`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+<body>`
	`2`	`+ Hello World!`
	`3`	`+</body>`