🦁 The fabulous cat of blockchain websites https://www.bigchaindb.com

Go to file

Matthias Kretschmann 7eda6abf14 Revert "prevent search engine indexing of beta & gamma" This reverts commit `8103c6884e`.		2017-03-20 15:52:10 +01:00
_aws	document AWS bucket policy	2017-03-01 14:55:11 +01:00
_ci	Revert "prevent search engine indexing of beta & gamma"	2017-03-20 15:52:10 +01:00
_src	Revert "prevent search engine indexing of beta & gamma"	2017-03-20 15:52:10 +01:00
docs	Updated front page & restyled menu & happy little things (#79 )	2016-11-14 11:59:16 +01:00
.editorconfig	finalized starting point	2015-12-20 05:22:45 +01:00
.gitignore	build tweaks	2017-03-04 23:15:46 +01:00
.travis.yml	hero cleanup (#101 )	2017-03-02 14:27:08 +01:00
Gemfile	switch to redcarpet for now, ref #11	2016-02-10 01:11:35 +01:00
README.md	introduce gamma	2017-03-07 16:24:23 +01:00
_config.yml	remove forestry related stuff (#90 )	2017-01-25 12:23:41 +01:00
favicon.ico	Update assets	2017-02-07 23:42:23 +01:00
gulpfile.js	set environment correctly again	2017-03-17 17:55:41 +01:00
package.json	package updates	2017-03-04 23:32:25 +01:00

README.md

BigchainDB

Landing page for BigchainDB

Live | Beta | Gamma | Styleguide

Development

You need to have the following tools installed on your development machine before moving on:

node.js & npm
(optional) use Yarn instead of npm for faster dependency installations
Ruby (for sanity, install with rvm)
Bundler

Install dependencies

Run the following command from the repository's root folder to install all dependencies.

npm i && bundle install

yarn && bundle install

Development build

Spin up local dev server and livereloading watch task, reachable under https://localhost:1337:

gulp

Continuous Delivery

The site gets built & deployed automatically via Travis under the following conditions:

every push builds the site
every push to the master branch initiates a live deployment
every pull request initiates a beta deployment

Manual Deployment

The site is hosted in an S3 bucket and gets deployed via a gulp task.

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:

[default]
aws_access_key_id = <YOUR_ACCESS_KEY_ID>
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.

If you've set them up as another profile, say [bigchain] you can grab those credentials by using the AWS_PROFILE variable like so:

AWS_PROFILE=bigchain gulp deploy --live

In case that you get authentication errors or need an alternative way to authenticate with AWS, check out the AWS documentation.

Production build & beta deployment

# make sure your local npm packages & gems are up to date
npm update && bundle update

# make production build in /_dist
gulp build --production

# deploy contents of /_dist to beta
gulp deploy --beta

There's also a second beta deployment target called gamma under http://gamma.bigchaindb.com:

# deploy contents of /_dist to gamma
gulp deploy --gamma

Production build & live deployment

# make sure your local npm packages & gems are up to date
npm update && bundle update

# make production build in /_dist
gulp build --production

# deploy contents of /_dist to live
gulp deploy --live