resource-watch/widget

# Widget Microservice

This repository contains the widget microservice for WRI API

[![Build Status](https://travis-ci.com/resource-watch/widget.svg?branch=dev)](https://travis-ci.com/resource-watch/widget)
[![Test Coverage](https://api.codeclimate.com/v1/badges/a5b0be0d7e79db309b30/test_coverage)](https://codeclimate.com/github/resource-watch/widget/test_coverage)

## Dependencies

The Widget 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:
- [Dataset](https://github.com/resource-watch/dataset/)
- [Graph Client](https://github.com/resource-watch/graph-client/)
- [Vocabulary](https://github.com/resource-watch/vocabulary-tag/)
- [Webshot](https://github.com/resource-watch/webshot)


## Getting started

Start by cloning the repository from github to your execution environment

```
git clone https://github.com/resource-watch/widget.git && cd widget
```

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](#configuration-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 install
```

3 - Start the application server:
```
yarn start
```

The endpoints provided by this microservice should now be available through the service'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 the microservice:

```
./widgetAdapter.sh develop
```

The endpoints provided by this microservice should now be available through the service'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:
```
./widget.sh test
```

## Configuration

It is necessary to define these environment variables:

* GATEWAY_URL => Gateway URL
* NODE_ENV => Environment (prod, staging, dev)