Skip to content

Commit

Permalink
Add StatsDownload setup documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Miguel Molina Jr committed Aug 22, 2018
1 parent 041a2f3 commit 126babe
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 3 deletions.
5 changes: 4 additions & 1 deletion docs/ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,15 @@ This is a C# implementation for downloading FAH statistics on a scheduled basis,
* Visual Studio 2017
* Microsoft SQL Server 2017
* ReSharper
* WiX

## Solutions

1. [StatsDownload](StatsDownload.ReadMe.md)
* The downloader interfaces with the StatsDownload database to upload the database with user statistics
2. [StatsDownloadApi](StatsDownloadApi.ReadMe.md)
2. [StatsDownloadSetup](StatsDownloadSetup.ReadMe.md)
* The downloader setup creates an installation package for Windows
3. [StatsDownloadApi](StatsDownloadApi.ReadMe.md)
* The API interfaces with the StatsDownload database to return the data within based on query parameters

## Versioning
Expand Down
4 changes: 2 additions & 2 deletions docs/StatsDownload.ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ The stats downloader is used to download the stats data on a scheduled basis.

## Installation

### Installing on Windows
### Installing on Windows w/ Installer

1. Place FileDownload and StatsUpload console applications in the desired directory
1. Install using latest available installation package
2. [Update applications configuration file](SettingsConfiguration.md)
3. Navigate to FLDCDotNet/Database
1. Run the schema script to create a database (update path to database)
Expand Down
20 changes: 20 additions & 0 deletions docs/StatsDownloadSetup.ReadMe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Stats Downloader Setup

## Getting Started

The stats downloader setup is used to create a Windows installation package to install the stats downloader.

## Prerequisites

* .NET Framework 4.7.1
* WiX

## Installation Package

### Creating the Installation Package

1. Load StatsDownload solution
2. Run unit tests and ensure all tests pass
3. Load StatsDownloadSetup solution
4. Publish StatsDownloadSetup solution
* Update target as needed e.g. Windows x86, Windows x64

0 comments on commit 126babe

Please sign in to comment.