site/README.md

🦁 The fabulous cat of blockchain websites.

---

Live | Styleguide | Beta | Gamma

---

• Documentation
• Development
  • Prerequisites
  • Get up and running
• Continuous deployment: always be shipping
• Manual deployment
  • Prerequisite: authentication
  • Staging build & beta deployment
  • Production build & live deployment
• Coding conventions
  • (S)CSS
  • JavaScript
• Authors
• License

Documentation

Have a look at the docs/ folder.

Development

The whole website is a Jekyll based site with a Gulp-based build pipeline in front of it.

Prerequisites

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

Get up and running

Run the following command from the repository's root folder to clone this repository, install all dependencies, and spin up local dev server reachable under http://localhost:1337:

git clone git@github.com:bigchaindb/site.git
cd site/
npm i && bundle install

# development build and dev server
gulp

Additionally, you can execute those commands to test the actual build output:

# full production build
gulp build --production

# build preventing search engine indexing & Google Analytics tracking
gulp build --staging

All builds are output into the _dist/ folder. Use a tool like serve to inspect a local build in your browser:

serve -s _dist

Continuous deployment: always be shipping

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
• live deployment: every push to the master branch initiates a live deployment
• beta deployment: every new pull request and every subsequent push to it initiates a beta deployment

Manual deployment

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

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 [bigchaindb] you can grab those credentials by using the AWS_PROFILE variable like so:

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.

Staging build & beta deployment

The staging build is a full production build but prevents search engine indexing & Google Analytics tracking.

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

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

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

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

# build preventing search engine indexing & Google Analytics tracking
gulp build --staging

# 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

Coding conventions

(S)CSS

Follows stylelint-config-bigchaindb which itself extends stylelint-config-standard.

Lint with stylelint in your editor or run:

npm test

JavaScript

It's a wild mess right now between old school vanilla js, jQuery and some ES2015 features. Don't bother with the old stuff unless dependency updates break it.

New js should follow eslint-config-ascribe. Linting in this repo is not setup for it yet.

Authors

• Matthias Kretschmann (@kremalicious) - BigchainDB & Ocean Protocol
• All the contributors

License

Copyright 2018 BigchainDB GmbH

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.