Skip to content

AGH-IO-Antreprenerzy/sumo-championship-manager

Repository files navigation

Sumo Championship Manager

Java Spring Boot Maven React Docker

About

System for sumo championship management. Created as a project for Software Engineering course at AGH University of Science and Technology (Computer Science studies).

Requirements

  • Java 17
  • Maven

Build and run

With Docker

Copy default.env into .env, then set correct values and execute:

docker-compose --env-file .env up --build

Without Docker

Backend

Basic run with Maven (without tests):

mvn clean install -DskipTests exec:java -Dexec.mainClass=com.sumoc.sumochampionship.SumoChampionshipApplication -DSUMO_DB_URL="<url>" -DSUMO_PASSWORD="<password>" -DSUMO_USERNAME="<username>"

Caution: You need to set the variables!

Frontend
  1. Install yarn:
npm install --global yarn
  1. Enter frontend/sumo-championship directory and run:
yarn install
  1. Run the frontend app:
yarn start

Authors

DEFINITION OF DONE

  1. Działa zgodnie z założeniami / spełnia kryteria akceptacyjne

    • Jeżeli w trakcie robienia taska okaże się, że coś musi/powinno być zrobione inaczej, to:
      • Konsultacja PO (obowiązkowa) odnośnie zmiany
      • Konsultacja z teamem/grupą w zależności od wielkości zmiany
      • Info w komentarzu/nowy task zależności od wielkości zmiany
  2. Code Review.

    • 1 osoba, a w razie potrzeby (big task/kontrowersje) 2 osoby
  3. Testy - jak są, to przechodzi

    • A co do tego, czy powinny być:
      • Front - Jak jest jakaś grubsza logika
      • Back - Testy dla story, jeden integracyjny
  4. Nie wybucha aplikacja

    • Bez QA sprawdzenia
    • Ten, kto pisze feature'a, powinien sprawdzić, czy nic nie wybuchło
    • Reviewer nie sprawdza tego
    • W momencie zauważenia, że coś wybuchło, reporter zgłasza, ale zajmuje się osobą poczuwającą się do odpowiedzialności (ten, kto robił w rejonie, gdzie wybuchło)
  5. Stan taska zgadza się z jego kolumną na Jirze (szczególnie przy merge'u, ale cały czas ma się zgadzać)