An open API service indexing awesome lists of open source software.

https://github.com/colinbut/github-cloud-proxy-app

A "Proxy" application that acts as a "Gateway" to GitHub Jobs REST API
https://github.com/colinbut/github-cloud-proxy-app

docker docker-compose influxdb java java-8 spring spring-boot spring-cloud spring-reactive

Last synced: 3 months ago
JSON representation

A "Proxy" application that acts as a "Gateway" to GitHub Jobs REST API

Awesome Lists containing this project

README

          

# Gateway Proxy App

In order to use this application you need to have [Java 8](https://www.oracle.com/technetwork/java/javase/overview/java8-2100321.html) installed as well as [Maven](http://maven.apache.org/).

To compile the application

```
mvn clean package
```

To run the application

```bash
KPI_DATABASE_URL=http://influxdb-url KPI_DATABASE_PASSWORD=password KPI_DATABASE_USERNAME=username mvn spring-boot:run
```

To dockerize the application

```bash
docker build -t 'githubcloudproxy:latest' .
```

The image can be found on [dockerhub](https://hub.docker.com/r/colinbut/githubcloudproxy)

To run using docker compose

```bash
docker-compose -f docker-compose.yaml up
```

Then you can use the gateway app proxy functionality

```bash
curl http://localhost:8080/positions.json?page=0
```

You can monitor the service health status with the following endpoint

```bash
curl http://localhost:8080/actuator/health
```

## Author

Colin But