bigchaindb/site
1
0
Fork 0
mirror of https://github.com/bigchaindb/site.git synced 2024-11-22 01:36:55 +01:00
Code Releases Activity

dev instructions tweaks

Browse Source
This commit is contained in:
Matthias Kretschmann 2018-04-11 16:07:20 +02:00
parent 763fa9cbdc
commit bb3b87c8c9
Signed by: m
GPG Key ID: 606EEEF3C479A91F
1 changed files with 24 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -16,11 +16,9 @@
--- ---
## Table of Contents
* [Development](#development) * [Development](#development)
* [Install dependencies](#install-dependencies) * [Prerequisites](#prerequisites)
* [Development build](#development-build) * [Get up and running](#get-up-and-running)
* [Continuous deployment: always be shipping](#continuous-deployment-always-be-shipping) * [Continuous deployment: always be shipping](#continuous-deployment-always-be-shipping)
* [Manual deployment](#manual-deployment) * [Manual deployment](#manual-deployment)
* [Prerequisite: authentication](#prerequisite-authentication) * [Prerequisite: authentication](#prerequisite-authentication)
@ -36,27 +34,41 @@
The whole website is a Jekyll based site with a Gulp-based build pipeline in front of it. 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: You need to have the following tools installed on your development machine before moving on:
- [node.js](http://nodejs.org/) & [npm](https://npmjs.org/) - [Node.js](http://nodejs.org/) & [npm](https://npmjs.org/)
- (optional) use [Yarn](https://yarnpkg.com) instead of npm for faster dependency installations
- [Ruby](https://www.ruby-lang.org) (for sanity, install with [rvm](https://rvm.io/)) - [Ruby](https://www.ruby-lang.org) (for sanity, install with [rvm](https://rvm.io/))
- [Bundler](http://bundler.io/) - [Bundler](http://bundler.io/)
### Install dependencies ### Get up and running
Run the following command from the repository's root folder to install all dependencies. 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 ```bash
git clone git@github.com:bigchaindb/site.git
cd site/
npm i && bundle install npm i && bundle install
# development build and dev server
gulp
``` ```
### Development build Additionally, you can execute those commands to test the actual build output:
Spin up local dev server and livereloading watch task, reachable under [http://localhost:1337](http://localhost:1337):
```bash ```bash
gulp # 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 ## Continuous deployment: always be shipping