/goldsrc-tracker

Track and set custom alerts for goldsrc games on player counts

Primary LanguageJavaScript

Build Status Codacy Badge

Goldsrc-Tracker

Tracks player counts on various goldsrc games / mods on steam and allows the setting of custom alerts when specified player thresholds are met.

Configuration

The majority of environment variables have defaults, these can be changed if required by setting the following environment variables.

Name Desc Default
REDIS_HOST Redis host 127.0.0.1
REDIS_PORT Redis port 6379
SESSION_SECRET Express sessions secret changeme
STEAM_API_KEY Your steam API key
DB_USER Postgres username postgres
DB_NAME Postgres database name postgres
DB_HOST Postgres database host 127.0.0.1
BASE_URL Application base url http://localhost:3000

Usage

  1. Start dependencies (redis, postgres)
docker-compose up -d
  1. Install packages
npm install
  1. Export Steam API key which can be generated at https://steamcommunity.com/dev/apikey
export STEAM_API_KEY={key}
  1. Start server
npm start

Testing

npm test