subspace-stats-web

This is a web application for viewing stats of games played using the matchmaking functionality provided with the Subspace Server .NET zone server. The matchmaking functionality for the zone server provides the ability to save stats to a subspace-stats-db database. This application provides a website interface to view that data.

The goal of this project is to provide a baseline implementation. It's meant to be able to be used directly as is, or can be modified to suit your specific needs.

This is a work in progress.

Development setup

Set up the database

This project uses the subspace-stats-db. See the instructions in that repository for instructions on how to set the database up.

Clone the repository

git clone https://github.com/gigamon-dev/subspace-stats-web.git

Configure the connection strings

This web application requires database connection strings to be configured.

Here's an example of what a connection string looks like:

Host=localhost;Username=webuser;Password=changeme;Database=subspacestats

It will vary based on where your hosting the database (the above example assumes it's being run locally), what username and password you set up for the web app to use, and what name the database was given when it was set up. There are also many other options that can configured.

See the npgsql documentation for details on Connection String Parameters.

There are 2 connection strings:

• one for the application: ConnectionStrings:SubspaceStats
• and one for ASP.NET Core Identity: ConnectionStrings:AspNetCoreIdentity

In development, the proper way to store the connection strings is by using User Secrets.

In your terminal, change to the the src/SubspaceStats directory, which contains the SubspaceStats.csproj file and use the .NET CLI to set the 2 connection strings in User Secrets.

The dotnet user-secrets tool command looks like:

dotnet user-secrets set "<key>" "<value>"

Where key is name of the connection string to set, and value is the connection string.

Use it to set both connection strings. The commands to run will look like this:

dotnet user-secrets set "ConnectionStrings:SubspaceStats" "<your website connection string with website user name and pw>"

dotnet user-secrets set "ConnectionStrings:AspNetCoreIdentity" "<your identity connection string with identity user name and pw>"

You can verify the settings are properly saved by running:

dotnet user-secrets list

NOTE: User Secrets should only be used in development. For production, the connection string would be accessed though an environment variable or an online secrets store depending on your host (e.g. Azure Key Vault). For more information see the official documentation: Protect secrets in development

Run EF migrations

ASP.NET Core Identity is used for authentication. However, database tables need to be created. It uses Entity Framework to manage its database objects.

If dotnet ef if not installed, install it as a global tool:

dotnet tool install --global dotnet-ef

Apply the migrations to initialize the database. This will create the database tables for ASP.NET Core Identity.

dotnet ef database update

Get the client-side scripts using LibMan

LibMan is a client-side library acquisition tool. It can be used to download the client-side libraries into the src/SubspaceStats/wwwroot/lib folder.

If you're using Visual Studio LibMan is built-in. Simply right click on the project and choose "Restore Client-Side Libraries".

Otherwise, use the LibMan CLI.

Install LibMan (if not previously installed). See the LibMan CLI Documentation for details.

From the src/SubspaceStats folder, which contains the libman.json file, run the following command.

libman restore