bigchaindb/site
1
0
Fork 0
mirror of https://github.com/bigchaindb/site.git synced 2024-11-21 17:26:55 +01:00
Code Releases Activity

document IPFS snapshots script

Browse Source
This commit is contained in:
Matthias Kretschmann 2017-08-14 20:08:38 +02:00
parent 49b41f4c84
commit 6cddd64a14
Signed by: m
GPG Key ID: 606EEEF3C479A91F
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -24,6 +24,7 @@
* [Prerequisite: authentication](#prerequisite-authentication)
* [Staging build & beta deployment](#staging-build--beta-deployment)
* [Production build & live deployment](#production-build--live-deployment)
* [IPFS snapshots](#ipfs-snapshots)
* [Coding conventions](#coding-conventions)
* [(S)CSS](#scss)
* [JavaScript](#javascript)
@ -135,6 +136,25 @@ gulp build --production
gulp deploy --live
```
## IPFS snapshots
While the site isn't hosted on IPFS, we upload selected snapshots to it and keep a history of those hashes in the `versions` folder. By prepending every hash with e.g. `https://ipfs.io/ipfs/` you can see all those versions.
To add a snapshot of the full site to IPFS manually run the `ipfs.sh` script:
```bash
./ipfs.sh
```
This will run a staging build, adds all contents of the output folder to IPFS and keeps track of this version via its IPFS hash in the `versions` folder.
Right now, this requires a running `ipfs daemon` on your machine before executing the script. On macOS it's as simple as:
```bash
brew install ipfs
ipfs daemon
```
## Coding conventions
### (S)CSS