Git Product home page Git Product logo

mk-scoreboard's Introduction

Features

  • Stats such as wins, win rate, points, points per game
  • Sort the scoreboard based on any of these stats
  • See change in position and points-per-game
  • Medals for high scores (e.g. ๐ŸŽ–๏ธ for max score)
  • Have multiple groups
  • Different max scores per group (e.g. 60 for 4 games, or 90 for 6 on Switch)
  • View player scores as graph (along with std. deviation)
  • Show a player's best streak of N games
  • Head-to-head - see only the games between the chosen players (graphs + scores)
  • Item randomiser (randomly pick a few items to use in "Custom Items" mode)

Scoreboard: scoreboard

Player score graph: player score graph

Head-to-head: head to head

Item randomiser: item randomiser


Technical Stack

  • Backend: ๐Ÿฆ€ Rust
  • Frontend: React + Vite + TS
  • Database: Postgres

Run Locally

Dependencies

  • sqlx-cli (cargo install sqlx-cli)
  • yarn

Setup

Environment Variables

To set up for development, copy .env.example to .env and fill it out with the development config

This also needs to be copied to db/.env

Database

To set up the database, run the following commands:

# Start the DB
cd db
source <env-file>
docker-compose up -d

# Run the migrations
cd ../backend
sqlx migrate run

You will then need to manually create players and groups in the database. Make sure to add the players to the groups using the player_group table

Frontend

Install dependencies:

cd ./frontend
yarn

Running

Run the database:

cd db
docker-compose up -d

Run the backend:

cd backend
cargo run # Or use `cargo watch -x run` to rebuild/run on file changes

Run the frontend:

cd frontend
yarn dev

Go to http://localhost:5173

mk-scoreboard's People

Contributors

jacob-horton avatar

Stargazers

 avatar Tom Heaton avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.