Added short README.md docs indicating necessary settings for API and frontend code bases

This commit is contained in:
Matthew Alan Gray 2022-10-03 12:41:38 -05:00
Родитель c1dd215a93
Коммит 58e4dc4bbb
2 изменённых файлов: 37 добавлений и 0 удалений

Просмотреть файл

@ -0,0 +1,11 @@
# Humongous.Healthcare.Web Web Application
This codebase is a representative example of a web frontend that makes calls to the Health Check tracking API service for Humongous Healthcare.
# Building the WebApp
Before building the web application, it is necessary to define the following environment variables that the React frontend uses to determine the API endpoint and API key necessary to make calls to the Health Check tracking API.
- REACT_APP_API_URL - The endpoint URL of the Health Check tracking API
- REACT_APP_API_KEY - The API key for accessing the Health Check tracking API

Просмотреть файл

@ -0,0 +1,26 @@
# Humongous.Healthcare API Service
This codebase is a representative example of a Health Check tracking API service for Humongous Healthcare.
# Running the API Service
To run the API service locally, it is necessary to define the `CosmosDb::Account` and `CosmosDb::Key` settings in the `appsettings.json` file to point to a valid CosmosDb account.
```json
{
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft": "Warning",
"Microsoft.Hosting.Lifetime": "Information"
}
},
"AllowedHosts": "*",
"CosmosDb": {
"Account": "<Replace with your account URL>", // <-- The CosmosDb Account
"Key": "<Replace with your account key>", // <-- The CosmosDb Access Key
"DatabaseName": "HealthCheckDB",
"ContainerName": "HealthCheck"
}
}
```