← how to get started with the dividend tracker api | dividend tracker api documentation
Overview: How-To do a Health-Check (and start your local server)
Scenario
You want to consume the Dividend Tracker API endpoints, but first want to test if the local server is up and running. This is referred to as a health-check.
Prerequisites
Before you begin, make sure you have:
- Node.js and npm installed on your system
- A basic working knowledge of JavaScript or Node.js
- Forked the Dividend Tracker API and cloned a copy to your local system.
Outline of Steps
The following steps must be completed in order:
- Step 1: Start the Dividend Tracker API server locally on your machine
- Step 2: Choose a method to test if you can reach the endpoint http://localhost:3000
- Method 1: Use your browser
- Method 2: Use the test-health.js script
- Method 3: Use your own script