Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 1.34 KB

README.md

File metadata and controls

46 lines (32 loc) · 1.34 KB

Citadel

Build Status Coverage Status Code Climate Dependency Status

Open Source, Web-based league system designed for games such as Team Fortress 2.

Goals

  • Highly configurable league system
  • Full automation for regular tasks (league management/setup, etc.)
  • Fine grained permission system

Dependencies

You will need:

  • Ruby 2.3.3
  • Bundler
  • Postgres (configured in config/database.yml)
  • ImageMagick

To install all other ruby dependencies, run:

bundle install

To configure secrets (ie. steam API key) for development, use config/secrets.local.yml. Example at config/secrets.local.yml.example. Or put the secrets in environment variables (SECRET_KEY_BASE, STEAM_API_KEY)

Tests

This project uses rspec, rubocop, haml-lint and rails-best-practices for testing and linting.

All of these can be run in one command with rake

rake
# or
rake test