psq / stacks-blockchain-sidecar

API for the Stacks 2.0 blockchain

Home Page:https://blockstack.github.io/stacks-blockchain-sidecar/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

@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.

About

API for the Stacks 2.0 blockchain

https://blockstack.github.io/stacks-blockchain-sidecar/

License:GNU General Public License v3.0


Languages

Language:TypeScript 94.0%Language:JavaScript 3.4%Language:Shell 2.3%Language:Dockerfile 0.4%