Global Forest Watch - Subscription API

This repository contains the microservice that handles subscriptions to forest change layers.

View the documentation for this API

Dependencies

You will need Control Tower up and running - either natively or with Docker. Refer to the project's README for information on how to set it up.

The Subscriptions microservice is built using Node.js, and can be executed either natively or using Docker, each of which has its own set of requirements.

Native execution requires:

• Node.js
• Redis
• MongoDB

Execution using Docker requires:

• Docker
• Docker Compose

Dependencies on other Microservices:

• Query
• Layer
• Dataset
• Geostore
• Area
• GFW user

Getting started

Start by cloning the repository from github to your execution environment

git clone https://github.com/gfw-api/gfw-subscription-api.git && cd gfw-subscription-api

After that, follow one of the instructions below:

Using native execution

1 - Set up your environment variables. See dev.env.sample for a list of variables you should set, which are described in detail in this section of the documentation. Native execution will NOT load the dev.env file content, so you need to use another way to define those values

2 - Install node dependencies using YARN:

yarn install

3 - Start the application server:

yarn start

The endpoints provided by this microservice should now be available through Control Tower's URL.

Using Docker

1 - Create and complete your dev.env file with your configuration. The meaning of the variables is available in this section. You can find an example dev.env.sample file in the project root.

2 - Execute the following command to run Control tower:

./subscription.sh develop

The endpoints provided by this microservice should now be available through Control Tower's URL.

Testing

There are two ways to run the included tests:

Using native execution

Follow the instruction above for setting up the runtime environment for native execution, then run:

yarn test

Using Docker

Follow the instruction above for setting up the runtime environment for Docker execution, then run:

./subscription.sh test

Configuration

Environment variables

• PORT => TCP port in which the service will run
• MICROSERVICE_TOKEN =>
• MONGO_PORT_27017_TCP_ADDR => IP/Address of the MongoDB server
• MONGO_PORT_27017_TCP_PORT => Port of the MongoDB server

You can optionally set other variables, see this file for an extended list.

Configuration

It is necessary to define these environment variables:

• API_GATEWAY_URI => Gateway Service API URL
• NODE_ENV => Environment (prod, staging, dev)
• REDIS_URL => Url of async queue
• SELF_REGISTRY => on/off to set auto registry in API Gateway