STLKER

A stock tracking application that utilizes RESTful and gRPC microservices and other key components of backend programming.

How it works?

The user sends a HTTP request to the control API's endpoint which then forwards it to the unary gRPC API. The gRPC API then sends a request to a third-party API, Alpha Vantage, and sends back the result to the user in a similar manner. If the user so wishes, they can interact with the gRPC service directly and call the unary functions as well as the ones that utilize bidirectional streaming, with the help of grpcurl.

Current Features

• Utilizes a unary and streaming gRPC microservice as well as a RESTful one
• JWT authentication and HTTP cookies
• Extensive use of GORM to interact with a PostgreSQL database
• Redis Caching for certain endpoints
• Open-Api/Swagger Documentation
• Test cases
• Docker support

Current endpoints

• /portfolios (Requires authentication)
• /portfolios/{portName} (Requires authentication)
• /portfolios/{portName}/{ticker} (Requires authentication)
• /stocks/more/{ticker}
• /stocks/{ticker}/{currency}
• /signup
• /login
• /logout (Requires authentication)
• /refresh (Requires authentication)
• /deleteuser (Requires authentication)

Documentation Sample

Utilizing grpcurl

To send a request directly to the unary rpc's, one needs to do the following:

  grpcurl --plaintext -msg-template -d '{"Ticker": "MSFT", "Destination":"USD"}' localhost:9090 Watcher/GetInfo

or

    grpcurl --plaintext -msg-template -d '{"Ticker": "MSFT", "Destination":"USD"}' localhost:9090 Watcher/MoreInfo

To send a request to the bidirectional rpc, one needs to do the following:

  grpcurl --plaintext -msg-template -d @ localhost:9090 Watcher/SubscribeTicker

This will create a connection that stays alive by which you can send many requests in the form of

  {"Ticker": "MSFT", "Destination": "EUR"}

and also be periodically updated with new stock price data. To terminate this connection a simple CTRL-C is sufficient.

Docker 🐳

The fastest way to deploy this application would be via Docker--specifically docker-compose. Certain environmental variables are hidden though, which Docker needs. However, error messages in the program will instruct you where to place your .env files. Then, you can run the entire application from root with a simple call to docker-compose --env-file {path-to-your-env-file}.env up. If you do not plan to use environmental variables or intend on hard-coding them into the application (not recommended) ignore the former and simply do docker-compose up from root.

Running locally (not recommended)

In order to run this application on your machine you would need to install and setup PostgreSQL or another SQL database and modify the ORM code accordingly. You would also need to install redis and download all the golang dependencies in /grpc and /control

Disclaimer

This program is not intended to provide real-time stock information as it utilizes free publicly available API's by Alpha Vantage which provides information that is slightly delayed.

License

© Furkan T. Ercevik

This repository is licensed with a GNU GPLv3 license.