Skip to content

Files

Latest commit

259ce0d · May 11, 2020

History

History
25 lines (13 loc) · 977 Bytes

readme.md

File metadata and controls

25 lines (13 loc) · 977 Bytes

@blockstack/stacks-blockchain-sidecar

Build Status

Quick Start

First, ensure Docker is installed on your machine.

Clone repo and install dependencies with npm install.

Run npm run dev:integrated.

This command will concurrently start the sidecar app and the service dependencies.

Check to see if the sidecar started successfully by visiting http://localhost:3999/sidecar/v1/status

Local Development

Setup Services

Then run npm run devenv:deploy which uses docker-compose to deploy the service dependencies (e.g. PostgreSQL, Blockstack core node, etc).

Running the server

To run the server in 'watch' mode (restart for every code change), run npm run dev:watch. You'll have a server on port 3999.