pimp the readme

This commit is contained in:
Matthias Kretschmann 2017-05-29 21:35:24 +02:00
parent 3132067932
commit a500c9a2ed
Signed by: m
GPG Key ID: BD3C1F3EDD7831FC
3 changed files with 41 additions and 12 deletions

View File

@ -1,11 +1,32 @@
# BigchainDB # [![site](media/repo-banner@2x.png)](https://www.bigchaindb.com)
> Landing page for BigchainDB > The fabulous cat of blockchain websites.
[![Build Status](https://travis-ci.com/ascribe/bigchain-website.svg?token=3psqw6c8KMDqfdGQ2x6d&branch=master)](https://travis-ci.com/ascribe/bigchain-website) [![Build Status](https://travis-ci.com/ascribe/bigchain-website.svg?token=3psqw6c8KMDqfdGQ2x6d&branch=master)](https://travis-ci.com/ascribe/bigchain-website)
<img src="http://forthebadge.com/images/badges/powered-by-electricity.svg" height="20"/>
<img src="http://forthebadge.com/images/badges/as-seen-on-tv.svg" height="20"/>
<img src="http://forthebadge.com/images/badges/uses-badges.svg" height="20"/>
---
[Live](https://www.bigchaindb.com) | [Styleguide](https://www.bigchaindb.com/styleguide/) | [Beta](http://beta.bigchaindb.com) | [Gamma](http://gamma.bigchaindb.com) [Live](https://www.bigchaindb.com) | [Styleguide](https://www.bigchaindb.com/styleguide/) | [Beta](http://beta.bigchaindb.com) | [Gamma](http://gamma.bigchaindb.com)
---
## Table of Contents
* [Development](#development)
* [Install dependencies](#install-dependencies)
* [Development build](#development-build)
* [Continuous deployment: always be shipping](#continuous-deployment-always-be-shipping)
* [Manual deployment](#manual-deployment)
* [Prerequisite: authentication](#prerequisite-authentication)
* [Staging build &amp; beta deployment](#staging-build--beta-deployment)
* [Production build &amp; live deployment](#production-build--live-deployment)
* [Coding conventions](#coding-conventions)
* [(S)CSS](#scss)
* [Authors](#authors)
## Development ## Development
You need to have the following tools installed on your development machine before moving on: You need to have the following tools installed on your development machine before moving on:
@ -37,19 +58,23 @@ Spin up local dev server and livereloading watch task, reachable under [https://
gulp gulp
``` ```
## Continuous Delivery ## Continuous deployment: always be shipping
The site gets built & deployed automatically via Travis under the following conditions: ![shipping](https://cloud.githubusercontent.com/assets/90316/26559768/e21e9724-44b1-11e7-90cf-6ef6ebb06d09.gif)
The site gets built & deployed automatically via Travis. This is the preferred way of deployment, it makes sure the site is always deployed with fresh dependencies and only after a successful build.
Build & deployment happens under the following conditions on Travis:
- every push builds the site - every push builds the site
- every push to the master branch initiates a live deployment - **live deployment**: every push to the master branch initiates a live deployment
- every pull request initiates a beta deployment - **beta deployment**: every new pull request and every subsequent push to it initiates a beta deployment
## Manual Deployment ## Manual deployment
The site is hosted in an S3 bucket and gets deployed via a gulp task. For emergency live deployments or beta & gamma deployments, the manual method can be used. The site is hosted in an S3 bucket and gets deployed via a gulp task.
### Prerequisite: Authentication ### Prerequisite: authentication
To deploy the site, you must authenticate yourself against the AWS API with your AWS credentials. Get your AWS access key and secret and add them to `~/.aws/credentials`: To deploy the site, you must authenticate yourself against the AWS API with your AWS credentials. Get your AWS access key and secret and add them to `~/.aws/credentials`:
@ -61,17 +86,17 @@ aws_secret_access_key = <YOUR_SECRET_ACCESS_KEY>
This is all that is needed to authenticate with AWS if you've setup your credentials as the default profile. This is all that is needed to authenticate with AWS if you've setup your credentials as the default profile.
If you've set them up as another profile, say `[bigchain]` you can grab those credentials by using the `AWS_PROFILE` variable like so: If you've set them up as another profile, say `[bigchaindb]` you can grab those credentials by using the `AWS_PROFILE` variable like so:
```bash ```bash
AWS_PROFILE=bigchain gulp deploy --live AWS_PROFILE=bigchaindb gulp deploy --live
``` ```
In case that you get authentication errors or need an alternative way to authenticate with AWS, check out the [AWS documentation](http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-configuring.html). In case that you get authentication errors or need an alternative way to authenticate with AWS, check out the [AWS documentation](http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-configuring.html).
### Staging build & beta deployment ### Staging build & beta deployment
The staging build is essentially a full production build but it prevents search engine indexing & Google Analytics tracking. The staging build is a full production build but prevents search engine indexing & Google Analytics tracking.
```bash ```bash
# make sure your local npm packages & gems are up to date # make sure your local npm packages & gems are up to date
@ -119,3 +144,7 @@ Rule exceptions:
- indentation: 4 spaces - indentation: 4 spaces
- use single quotes - use single quotes
- allow single line rule sets - allow single line rule sets
## Authors
- Matthias Kretschmann ([@kremalicious](https://github.com/kremalicious)) - [BigchainDB](https://www.bigchaindb.com)

BIN
media/repo-banner.sketch Normal file

Binary file not shown.

BIN
media/repo-banner@2x.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB