gfw-api/gfw-viirs-fires-api

# GFW Fires API

[![Build Status](https://travis-ci.com/gfw-api/gfw-viirs-fires-api.svg?branch=dev)](https://travis-ci.com/gfw-api/gfw-viirs-fires-api)
[![Test Coverage](https://api.codeclimate.com/v1/badges/5978e5b572f6194cbe42/test_coverage)](https://codeclimate.com/github/gfw-api/gfw-viirs-fires-api/test_coverage)

This repository is the microservice that it implement the viirs fires functionality and exposed the /viirs-active-fires
endpoint in the api-gateway

## Dependencies

You will need [Control Tower](https://github.com/control-tower/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 GFW Fires API microservice is built using [Node.js](https://nodejs.org/en/), and can be executed either natively or
using Docker, each of which has its own set of requirements.

Native execution requires:

- [Node.js](https://nodejs.org/en/)
- [MongoDB](https://www.mongodb.com/)

Execution using Docker requires:

- [Docker](https://www.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/)

Dependencies on other Microservices:

- [Geostore](https://github.com/gfw-api/gfw-geostore-api/)
- [Dataset](https://github.com/resource-watch/dataset/)
- [Query](https://github.com/resource-watch/query/)

## Getting started

Start by cloning the repository from github to your execution environment

```
git clone https://github.com/gfw-api/gfw-viirs-fires-api.git && cd gfw-viirs-fires-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](#environment-variables) 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
```

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](#configuration-environment-variables). You can find an example `dev.env.sample` file in the project root.

2 - Execute the following command to run Control tower:

```
./viirsFires.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:

```
./viirsFires.sh test
```

## Configuration

### Environment variables

- PORT => TCP port in which the service will run
- NODE_PATH => relative path to the source code. Should be `app/src`
- MICROSERVICE_TOKEN =>

You can optionally set other variables, see [this file](config/custom-environment-variables.json) for an extended list.