Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/resource-watch/proxy
https://github.com/resource-watch/proxy
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/resource-watch/proxy
- Owner: resource-watch
- License: mit
- Created: 2018-03-20T15:33:54.000Z (over 6 years ago)
- Default Branch: dev
- Last Pushed: 2024-01-09T09:45:33.000Z (10 months ago)
- Last Synced: 2024-06-11T17:18:01.820Z (5 months ago)
- Language: JavaScript
- Size: 1.21 MB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Proxy Microservice
[](https://travis-ci.com/resource-watch/proxy)
[](https://codeclimate.com/github/resource-watch/proxy/test_coverage)
## 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 Proxy 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/)
Execution using Docker requires:
- [Docker](https://www.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/)
## Getting started
Start by cloning the repository from github to your execution environment
```
git clone https://github.com/resource-watch/proxy.git && cd proxy
```
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:
```
./proxy.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:
```
./proxy.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 => token to be used for authenticating requests to the microservice
You can optionally set other variables, see [this file](config/custom-environment-variables.json) for an extended list.