mirror of
https://github.com/bigchaindb/site.git
synced 2024-11-24 10:43:55 +01:00
194 lines
6.7 KiB
Markdown
194 lines
6.7 KiB
Markdown
# [](https://www.bigchaindb.com)
|
|
|
|
> 🦁 The fabulous cat of blockchain websites.
|
|
|
|
[](https://travis-ci.com/bigchaindb/site)
|
|
[](https://github.com/bigchaindb/stylelint-config-bigchaindb)
|
|
[](https://github.com/ascribe/javascript)
|
|
[](https://greenkeeper.io/)
|
|
<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)
|
|
|
|
---
|
|
|
|
* [Documentation](#documentation)
|
|
* [Development](#development)
|
|
* [Prerequisites](#prerequisites)
|
|
* [Get up and running](#get-up-and-running)
|
|
* [Continuous deployment: always be shipping](#continuous-deployment-always-be-shipping)
|
|
* [Manual deployment](#manual-deployment)
|
|
* [Prerequisite: authentication](#prerequisite-authentication)
|
|
* [Staging build & beta deployment](#staging-build--beta-deployment)
|
|
* [Production build & live deployment](#production-build--live-deployment)
|
|
* [Coding conventions](#coding-conventions)
|
|
* [(S)CSS](#scss)
|
|
* [JavaScript](#javascript)
|
|
* [Authors](#authors)
|
|
* [License](#license)
|
|
|
|
## Documentation
|
|
|
|
Have a look at the [`docs/`](docs/) folder.
|
|
|
|
## Development
|
|
|
|
The whole website is a Jekyll 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](http://nodejs.org/) & [npm](https://npmjs.org/)
|
|
- [Ruby](https://www.ruby-lang.org) (for sanity, install with [rvm](https://rvm.io/))
|
|
- [Bundler](http://bundler.io/)
|
|
|
|
### 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](http://localhost:1337):
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
# 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](https://github.com/zeit/serve) to inspect a local build in your browser:
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
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).
|
|
|
|
### Staging build & beta deployment
|
|
|
|
The staging build is a full production build but prevents search engine indexing & Google Analytics tracking.
|
|
|
|
```bash
|
|
# 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:
|
|
|
|
```bash
|
|
# build preventing search engine indexing & Google Analytics tracking
|
|
gulp build --staging
|
|
|
|
# deploy contents of /_dist to gamma
|
|
gulp deploy --gamma
|
|
```
|
|
|
|
|
|
### Production build & live deployment
|
|
|
|
```bash
|
|
# 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](https://github.com/bigchaindb/stylelint-config-bigchaindb) which itself extends [stylelint-config-standard](https://github.com/stylelint/stylelint-config-standard).
|
|
|
|
Lint with [stylelint](https://stylelint.io) in your editor or run:
|
|
|
|
```bash
|
|
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](https://github.com/ascribe/javascript). Linting in this repo is not setup for it yet.
|
|
|
|
## Authors
|
|
|
|
- Matthias Kretschmann ([@kremalicious](https://github.com/kremalicious)) - [BigchainDB](https://www.bigchaindb.com) & [Ocean Protocol](https://oceanprotocol.com)
|
|
- [All the contributors](https://github.com/bigchaindb/site/graphs/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.
|
|
```
|