Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 1.42 KB

StatsDownloadApi.ReadMe.md

File metadata and controls

59 lines (38 loc) · 1.42 KB
Raw

Stats API

Getting Started

The stats API is used to expose the stats, users, and team data from the stats database.

Prerequisites

  • .NET Core 2.1
  • Microsoft SQL Server 2017

Installation

Publishing to Azure

  1. Load StatsDownloadApi in VS
  2. Publish StatsDownloadApi.WebApi project
  3. Ensure connection string 'FoldingCoin' for the API is pointing to a StatsDownload database
  4. Configure additional application settings if needed

Settings

  1. Logging Settings
  2. Database Settings
  3. Email Settings

Applications

  1. WebApi
    • This is an API meant to provide services to various web applications

Using the API

Additional documentation on using the API

Running the tests

Unit Tests

Options for running the unit tests:

  • Use ReSharper's Test Runner from within Visual Studio
  • Use the nunit console runner, using a command such as:
nunit-console {path-to-assembly}

Integration Tests

  1. Load the database with a test dataset
  2. Run API pointing to previous database
  3. Run tests

Deployment

Api Hardware Requirements

  • SDD 120GB+
  • i5 Intel / Ryzen 5 AMD
  • 16 GB