/bcd

Tezos contract explorer and developer dashboard

Primary LanguageVueMIT LicenseMIT

Better Call Dev

Build Status Docker Build Status Made With: Vue.js License: MIT

BCD is:

Versioning

BCD uses the same X.Y.Z scheme as BCDHub (see https://github.com/baking-bad/bcdhub#versioning)

Configuration

Build-time .env.* files

  • NODE_ENV production for production env, development otherwise
  • BASE_URL set to https://better-call.dev/ for production
  • VUE_APP_CONFIG_PATH path to the runtime config file (stored in public)

Runtime config.json

Reloaded each time you press F5 in the browser.

Required fields

  • API_URI base URL for BCDHub API, e.g. https://api.better-call.dev/v1/
  • WS_URI WebSocket endpoint, e.g. wss://api.better-call.dev/v1/ws
  • GA_ENABLED enable Google Analytics
  • MEMPOOL_ENABLED query mempool operations
  • HOME_PAGE redirect to this page unless it's home

Sandbox environment

  • SANDBOX_MODE activate single user mode
  • JUPYTER_PATH base URL for Jupyter notebook server

Docker image

BCD docker images are being built on dockerhub. Two types of tags are provided:

  • latest should be considered experimental
  • X.Y stable releases

Local build

make image  # latest

Release

Publishing a release is essentially tagging a commit.
IMPORTANT: bump version in package.json for each stable candidate or hotfix.

Latest

Will not be published as a release on GitHub. Docker image will be built though.

make latest

Stable

Takes current version from the package.json. Publishes release file on GitHub and builds a docker image tagged X.Y

make release

Deployment

Production better-call.dev

  • Requires local nginx setup, uses /var/www/bcd folder
  • Uses .env.production and config.production.json configs
  • Command: make deploy

Staging you.better-call.dev

Sandbox bbbox

Development

Install

Requires Node.js 11.4+

git clone https://github.com/baking-bad/bcd.git
cd bcd
npm i

Run

Local API localhost:14000

Sandbox API localhost:42000

Staging API you.better-call.dev

  • Connects to the public API instance
  • Uses .env.you and config.you.json configs
  • Command: make you

Publications

Contact us

About

Project is supported by Tezos Foundation