https://github.com/aman7123/capstone-portfolio-binder
Daniel Carson and Aaron Renner
https://github.com/aman7123/capstone-portfolio-binder
Last synced: 3 months ago
JSON representation
Daniel Carson and Aaron Renner
- Host: GitHub
- URL: https://github.com/aman7123/capstone-portfolio-binder
- Owner: Aman7123
- Created: 2020-09-22T00:16:38.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-03T21:01:25.000Z (over 4 years ago)
- Last Synced: 2025-01-14T02:28:58.906Z (5 months ago)
- Language: HTML
- Size: 10.2 MB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Table of Contents
## About The Project
[![Product Name Screen Shot][product-screenshot]](https://covid.aaronrenner.com)
This application has been created as an examples of creating connected software to inform people of the threat of the SARS-COV-2 virus across the United States. The basis and guidelines for this project application are provided from our Senior Capstone Project at [Shepherd University, Shepherdstown, WV 25443](https://goo.gl/maps/e3RNCSLP5NYajBwd7). We opted to use a Web Application using the frameworks provided by the Microsoft Dotnet core, this called a [Blazor Web Application](https://dotnet.microsoft.com/apps/aspnet/web-apps/blazor).
### Built With
* [COVID Tracking Project](https://covidtracking.com/data/api)
* [Microsoft Visual Studio CE](https://visualstudio.microsoft.com/vs/community/)
* [Dotnet Core](https://dotnet.microsoft.com/download/dotnet-core/3.1)
* [Blazor Web Application](https://dotnet.microsoft.com/apps/aspnet/web-apps/blazor)
* [Docker](https://www.docker.com/)
## Getting Started
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
### Prerequisites
Your machine will require dotnot resources to execute our application, make sure you have at least version 3. If you need to to install these resources check [Dotnet Core 3.1](https://dotnet.microsoft.com/download/dotnet-core/3.1)
```sh
dotnet --version
```
### Installation
1. Clone the repo
```sh
git clone https://github.com/Aman7123/Capstone-Portfolio-Binder.git
```
2. Frome the home directory, goto the project
```sh
cd COVIDBlazorApp/
```
3. If you have Dotnet installed you should be able to restore the project assets
```sh
dotnet restore
```
3. You can run this project on your local machine
```sh
dotnet run BlazorApp1.csproj
```
4. Navigate to your browser and access [localhost:5000](http://localhost:5000)
### Docker
If you are familiar with using Docker to run your project and it is installed on your machine I recommend using the build and run commands below.
1. From the root Github repo folder run
```sh
dotnet build --tag covid:1.0 .
```
2. After your image is created you can execute the webserver on your local machine by running
```sh
docker run --detach --p 5000:5000 --name covid covid:1.0
```
4. Navigate to your browser and access [localhost:5000](http://localhost:5000)
## API
To build our Website we required obtaining data related to the Coronavirus Pandemic by utilizing [The COVID Tracking Project API](https://covidtracking.com/data/api), this API collects Coronavirus data from local state governments in the United States and reviews all the data to ensure it is valid.
* For the Coronavirus statistics for the whole United States today use
```http
GET https://api.covidtracking.com/v1/us/current.json
```
```json
{
"date": int,
"states": int,
"positive": int,
"negative": int,
"pending": int,
"hospitalizedCurrently": int,
"hospitalizedCumulative": int,
"inIcuCurrently": int,
"inIcuCumulative": int,
"onVentilatorCurrently": int,
"onVentilatorCumulative": int,
"recovered": int,
"death": int,
"totalTestResults": int,
"deathIncrease": int,
"hospitalizedIncrease": int,
"negativeIncrease": int,
"positiveIncrease": int,
"totalTestResultsIncrease": int,
"hash": string
}
```
## Contact
* Aaron Renner - [Github Profile](https://github.com/Aman7123/)
* Daniel Carson - [Github Profile](https://github.com/doit4dan/)
Project Link: [https://github.com/Aman7123/Capstone-Portfolio-Binder](https://github.com/Aman7123/Capstone-Portfolio-Binder)
## Acknowledgements
* [Dotnet Blazor App getting started](https://dotnet.microsoft.com/learn/aspnet/blazor-tutorial/intro)
* [Visual Studio Community Edition 2019 getting started](https://docs.microsoft.com/en-us/visualstudio/install/install-visual-studio?view=vs-2019)
* [Docker getting started](https://docs.docker.com/get-started/)
* [Shepherd University Department of Computer, Science and Mathematics](https://www.shepherd.edu/cme)
[product-screenshot]: images/App_US_Data.png