Blinktrade Bitcoin Exchange

Technologies we are using

• jekyll, a static generator in Ruby, to create the static html pages
• google closure library for the javascript application
• google closure templates for some of the javascript ui views

Install prerequisites

Install Git, Ruby, Bundler and Java, in case you don't have them yet.

• Git any version
• Java 11
• Ruby 2.7.4
• Bundler 2.1.4

Ruby Gems (see Gemfile)

• jekyll 3.9.2
• jekyll-multiple-languages-plugin 1.8.0
• github-pages 227

Ruby and Bundler are preferably managed by rbenv.

Install required ruby gems

$ bundler install

Build & deploy using helper scripts

Build javascript

$ ./build_javascript.sh

Build and deploy mainnet to GitHub Pages

$ build_and_deploy_mainnet.sh

Manual build & deploy

1. Build the JavaScript application

Only needed in case you changed the ./jsdev application.

Compile all Javascript

It will compile for all themes and languages.

./build_javascript.sh

Compile a specific theme or language

The defaults are US english (en_US) and the default theme ('default'), but can be overridden. To build the british english version with a custom theme:

$ cd ./jsdev 
$ THEME=custom sh build_templates.sh
$ LANG=en_US THEME=custom sh build_js.sh

2A. Run the exchange locally

1. Fork the repo

2. Rename it to exchange or any name you wish. Let's use exchange for this example

3. clone your new repo

$ git clone https://github.com/yourgithubusername/exchange
$ cd exchange

4. Create a symbolic link to some _config.foxbit.yml files

$ ln -s _config.demo.yml _config.yml

5. And finally run:

$ bundle exec jekyll server --watch

You'll have access to the website at localhost:4000

2B. Deploy the exchange to GitHub Pages

Build the static site with Jekyll

mkdir -p _site_mainnet
git clone --depth 1 --single-branch --branch gh-pages git@github.com:vbtc/vbtc.github.io.git _site_mainnet
bundle exec jekyll build --config _config.yml,_config.vbtc.mainnet.yml

Deploy to GitHub Pages

cd _site_mainnet
git add .
git commit "Deploying next version"
git push

File Structure

_includes

They're blocks of code used to generate the main page of the site (index.html).

_layouts

Here you'll find the default template of the application.

_posts

Here you'll find a list of files for each post.

_config.yml

It stores most of the settings of the application.

index.html

The static html page

jsdev

The google closure javascript application

assets

Images, CSS, Compiled JavaScripts, Fonts and all static content.

Credits

The exchange was originally built by Blinktrade, Inc.

From the start of 2023 BitcoinVN took over and restarted active development.

License

GNU GENERAL PUBLIC LICENSE © Blinktrade, Inc.