alpha-vantage-service

module
v0.0.0-...-0a75d17 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 8, 2020 License: MIT

README

alpha-vantage-service

Build codecov Go Report Card

A service utilizing the Alpha Vantage API.

Features

  • CODEOWNERS for defining roles and responsibilities
  • Hermetic Docker builds
  • An extremely small Docker container (< 4 MB) from some optimizations in how the Go binary is created

Usage

Get an API key from Alpha Vantage and export it as an environment variable named $ALPHA_VANTAGE_API_KEY. Then run either the commands below for a standard or containerized build:

# Build a standard binary and run it...
make run

# ...or build a container and run it
make docker
docker run -it --rm -p 50051:50051 -e ALPHA_VANTAGE_API_KEY=$ALPHA_VANTAGE_API_KEY docker.pkg.github.com/brymck/alpha-vantage-service/alpha-vantage-service

If you have gRPCurl installed, you can test the service with the scripts in bin/:

bin/ts HYG
bin/quote IVV

Once deployed, you can

make client
ADDR=$(gcloud run services describe alpha-vantage-service --platform managed --format 'value(status.url.scope())'):443

./client IVV

Directories

Path Synopsis
cmd
web
genproto
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL