kylefang/stacks-blockchain-api
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks-blockchain-api.git synced 2026-01-12 22:43:34 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
stacks-blockchain-api/content/getting-started.md
max-crawford 3bbf91a9b8 docs: Update getting-started.md (#1718) [skip ci] 
Added a link to download docker
2023-10-02 21:19:32 -06:00

848 B
Raw Permalink Blame History

Title
Title
Getting Started

Getting Started

This page describes how you can start the API server and service dependencies.

Prerequisites

Before you can start the API server and its dependencies, you must first ensure that Docker is already installed on your machine. If you do not aready have Docker installed, please install Docker here.

Starting the API Server

To start the API server:

  1. Clone the Stacks Blockchain API repository.
  2. Install the related dependencies with the following command:

npm install

  1. Start the API server and service dependencies by entering the following command in your terminal:

Run npm run dev:integrated

  1. Verify the server has started successfully by going to http://localhost:3999/extended/v1/status.