The blockchain database network for the decentralized stack https://ipdb.io

Live | Styleguide

Table of Contents

• Content editing
  • Pages
  • Special pages
  • Front page
• Development
  • Install dependencies
  • Development build
• Continuous deployment: always be shipping
• Manual deployment
  • Prerequisite: authentication
  • Staging build & beta deployment
  • Production build & live deployment
• Coding conventions & Browser support
  • (S)CSS
  • js
• Authors & Contributors
• License

Content editing

Most content on the site can be edited on GitHub without messing with HTML markup.

The site's source and structure is in the _src/ folder. Ignore everything with an underscore in its name.

When viewing a file on GitHub you will see a small pencil icon in the top right. Click that to edit the file.

Pages

All pages are simple Markdown files. Markdown is a way of telling the site how an element should be marked up, like headings & bold text:

I'm a simple paragraph. No fancy symbols needed.

# I'm a heading 1
## I'm a heading 2

You can make text **bold like so**

Special pages

Some pages like front page source their content dynamically during site build. This is so we have a single source of truth for content used in multiple places on the site.

• _src/_data/content-front.yml
• _src/_data/content-foundation.yml

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

AWS_PROFILE=ipdb 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
# build preventing search engine indexing & Google Analytics tracking
gulp build --staging

# 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

Coding conventions & Browser support

Lint with ESLint & stylelint in your editor or run:

npm test

As a rule of thumb, make your CSS & JavaScript work in the last 2 versions of modern browsers, and ideally in IE 11. Adapt the browserslist key values in the package.json when a change in visitor statistics allows that.

(S)CSS

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

js

Follows ascribe/javascript which itself extends airbnb/javascript.

Try to not use any jQuery, always prefer vanilla JavaScript.

At the moment, jQuery is only used for the form submissions for its simple $.ajax functionality, and neither XMLHttpRequest or fetch seem to work with MailChimp.

Authors & Contributors

• Greg McMullen (@gmcmullen) - IPDB Foundation
• Matthias Kretschmann (@kremalicious) - BigchainDB/Ocean Protocol
• Members of the BigchainDB development team
• Representatives of Caretakers in the IPDB

License

For all code in this repository the Apache License, Version 2.0 is applied.

Copyright Interplanetary Database Foundation 2018. All rights reserved.

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.