soca-git / stocks-api

A personal project which aims to create an API-powered Stocks application, based on MacOS Stocks.

Stocks Application

A personal project which aims to create an API-powered Stocks application, based on MacOS Stocks.
App is deployed @ https://stocks-api-app.herokuapp.com/redoc -> note that if the Heroku server is asleep, it may take some time to load. I automatically ping the servers frequently to try and prevent them from falling asleep! I have a work-around in the pipeline to keep them awake 24/7.

This project is continuously being updated; progress is tracked here.

A walkthrough of the project's features can be found here.

Links

• ASP.NET Core API Docs
• OpenAPI
• NSwag
• NSwag (AspNetCore Middleware)
• Redocly
• IEXSharp
• xUnit
• Moq
• PostmanAPI
• Docker
• Heroku

Stocks-API

IEX Cloud Local Setup

Local usage of this API's financial data endpoints requires an IEXCloud account. A free trial account can be setup easily.
Set the public & secret keys inside environment variables as follows.

Windows 11:

• Open the start menu.
• Type edit ENV into the search bar and hit enter.
• Add IEX_PK and IEX_SK as user or system variables with their respective values from your IEXCloud account.

Docker & Heroku Deployment

The application is deployed via a Docker container to Heroku. The Dockerfile is generated through Visual Studio Container Tools (Right-Click Host Project > Add > Docker Support).

---