This repository contains the widget microservice for WRI API
The Widget 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:
Execution using Docker requires:
Dependencies on other Microservices:
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:
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 the service's URL.
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 the microservice:
./widgetAdapter.sh develop
The endpoints provided by this microservice should now be available through the service's URL.
There are two ways to run the included tests:
Follow the instruction above for setting up the runtime environment for native execution, then run:
yarn test
Follow the instruction above for setting up the runtime environment for Docker execution, then run:
./widget.sh test
It is necessary to define these environment variables:
- GATEWAY_URL => Gateway URL
- NODE_ENV => Environment (prod, staging, dev)