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

Go to file

carlysheridan 5933898ccd Update 404.md		2016-03-03 18:24:06 +01:00
_ci	switch to continuous delivery: live deploy master branch	2016-03-03 17:46:59 +01:00
_src	Update 404.md	2016-03-03 18:24:06 +01:00
docs	wording	2016-02-19 20:36:09 +01:00
.editorconfig	finalized starting point	2015-12-20 05:22:45 +01:00
.gitignore	ignore awspublish cache files	2016-01-08 15:37:40 +01:00
Gemfile	switch to redcarpet for now, ref #11	2016-02-10 01:11:35 +01:00
README.md	add codeship badge	2016-03-03 17:56:56 +01:00
_config.yml	link to Gitter room	2016-02-19 15:52:10 +01:00
gulpfile.js	switch to Noto Sans, kick out Fira	2016-02-10 01:11:35 +01:00
package.json	1.4.1	2016-02-29 16:20:09 +01:00

README.md

BigchainDB

Landing page for BigchainDB

Live | Beta | Styleguide

Development

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

node.js & npm
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

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 Codeship under the following conditions:

every push builds the site
every push to the master branch initiates a live deployment
every push to a branch starting with feature 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

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