Skip to content

scoringengine/scoringengine

Repository files navigation

Documentation Status CI Coverage Status

Scoring Engine

Scoring Engine is an open-source platform for running Red/White/Blue team competitions. It automates service checks each round and provides a web-based scoreboard and configuration interface.

Scoring Engine screenshot

Features

  • Automated scheduling and execution of service checks
  • Redis-backed workers for parallel execution
  • Web interface for viewing scores and configuring services
  • JSON API for programmatic access to scores and configuration
  • Example mode with pre-populated demo data

Prerequisites

Quick Start

From this directory run:

docker-compose build
docker-compose up

Optional environment variables

Reset the database before starting:

SCORINGENGINE_OVERWRITE_DB=true docker-compose up

Run with sample data and only the web UI:

SCORINGENGINE_EXAMPLE=true docker-compose up

Once running, access the application at http://localhost.

Log in using any of the following credentials:

  • whiteteamuser:testpass
  • team1user1:testpass
  • team2user1:testpass
  • team2user2:testpass
  • redteamuser:testpass

Documentation

Full documentation is available at https://scoringengine.readthedocs.io/en/latest/.

Building Documentation Locally

To build the documentation locally:

pip install -r docs/requirements.txt
cd docs
make html

Open docs/build/html/index.html in your browser to view the rendered documentation.

Tests and Code Style

Run the linters and test suite before submitting changes:

pre-commit run --files <changed-files>
pytest

To check every file, use pre-commit run --all-files.

License

Released under the MIT License.

About

Scoring Engine for Red/White/Blue Team Competitions

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 13