Skip to content

Commit

Permalink
feat: first docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@sWalbrun
sWalbrun committed Feb 24, 2024
1 parent fafc6fd commit 60cee3c
Show file tree
Hide file tree
Showing 5 changed files with 292 additions and 0 deletions.
Binary file added docs/assets/UserImportTemplate.xlsx
View file
Binary file not shown.
211 changes: 211 additions & 0 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,211 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Beitragsrunde - Getting started</title>
<link rel="stylesheet" href="styles.css">
</head>
<body>
<h1>Beitragsrunde - Getting started</h1>

<div class="container">
<div class="cards">
<!-- Card 1 -->
<div class="card-header" onclick="toggleCard(1)">
<h2>
Anmeldung <span><i id="icon1" class="fa-solid fa-chevron-down"></i></span>
</h2>
</div>
<div class="card-header" onclick="toggleCard(3)">
<h2>
Benutzer anlegen <span><i id="icon3" class="fa-solid fa-chevron-down"></i></span>
</h2>
</div>
<div class="card-header" onclick="toggleCard(4)">
<h2>
Benutzer anlegen - Massenimport <span><i id="icon4" class="fa-solid fa-chevron-down"></i></span>
</h2>
</div>
<div class="card-header" onclick="toggleCard(2)">
<h2>
Beitragsrunde anlegen <span><i id="icon2" class="fa-solid fa-chevron-down"></i></span>
</h2>
</div>
<div class="card-header" onclick="toggleCard(9)">
<h2>
Gebote abgeben <span><i id="icon9" class="fa-solid fa-chevron-down"></i></span>
</h2>
</div>
<div class="card-header" onclick="toggleCard(8)">
<h2>
Gebote für Benutzer abgeben <span><i id="icon8" class="fa-solid fa-chevron-down"></i></span>
</h2>
</div>
<div class="card-header" onclick="toggleCard(6)">
<h2>
Benutzer aus Beitragsrunde entfernen <span><i id="icon6" class="fa-solid fa-chevron-down"></i></span>
</h2>
</div>
<div class="card-header" onclick="toggleCard(7)">
<h2>
Runde ermitteln<span><i id="icon7" class="fa-solid fa-chevron-down"></i></span>
</h2>
</div>
<div class="card-header" onclick="toggleCard(5)">
<h2>
Gebote exportieren <span><i id="icon5" class="fa-solid fa-chevron-down"></i></span>
</h2>
</div>
</div>

<div class="card-detail" id="card-detail1">
<h2>Anmeldung</h2>
<p>Die Beitragsrunde benötigt keine Passwörter. Einfach die E-Mail-Adresse angeben und den Anmeldelink im
Postfach öffnen.</p>
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/wIeyCU7ovfw?si=UGILX_sgn3Q1ts-4"
title="YouTube video player" frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen></iframe>
</div>

<div class="card-detail" id="card-detail2">
<h2>Beitragsrunde anlegen</h2>
<p>Eine Beitragsrunde hat einen Abstimmungszeitraum und beliebig viele Produkte.</p>
<h3>Produkte</h3>
<ul>
<li>
Sobald der Abstimmungszeitraum beginnt, können die Mitglieder ihre Gebote abgeben
</li>
<li>Die Mitglieder können pro Produkt so viele Gebote abgeben, wie Anzahl an Runden konfiguriert werden. Es
können im Nachhinein noch weitere Runden hinzugefügt werden
</li>
<li>
Der Richtwert ist der benötigte Betrag für das Gartenjahr
</li>
<li>
Alle zuvor angelegten Benutzer werden automatisch eingeladen
</li>
<li>
Es kann immer nur eine Beitragsrunde durchgeführt werden. Eine Beitragsrunde kann aber beliebig viele
Produkte enthalten
</li>
</ul>
<div class="video">
<iframe width="1120" height="630"
src="https://www.youtube-nocookie.com/embed/VrrHMvJKSCM?si=PuTluCSQrKEtpl9r"
title="YouTube video player" frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen></iframe>
</div>
</div>

<div class="card-detail" id="card-detail3">
<h2>Benutzer anlegen</h2>
<p>Um einen Benutzer anlegen zu können, ist nur ein Name und eine E-Mail-Adresse notwendig. Sonst nichts.</p>
<h3>Benutzerrollen</h3>
<ul>
<li><b>Admin</b>: Kann Beitragsrunde und Benutzer verwalten</li>
<li><b>Benutzer</b>: Kann an einer Beitragsrunde teilnehmen</li>
</ul>
<div class="video">
<iframe width="1120" height="630"
src="https://www.youtube-nocookie.com/embed/c7WePLOemM0?si=gf3P1ejZgU-tw4L2"
title="YouTube video player" frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen></iframe>
</div>
</div>
<div class="card-detail" id="card-detail4">
<h2>Benutzer anlegen - Massenimport</h2>
<p>Benutzer können auch via <code>xlsx</code> oder <code>csv</code> importiert werden.</p>
<p>Einfach diese Vorlage befüllen und importieren:
<i><a href="assets/UserImportTemplate.xlsx">Benutzervorlage</a></i>
</p>
<span class="caution"><i class="fa-solid fa-triangle-exclamation"></i> Bei doppelten E-Mail-Adressen wird nur ein Benutzer angelegt.</span>
<div class="video">
<iframe width="1120" height="630"
src="https://www.youtube-nocookie.com/embed/cCFyekiHvN0?si=khKeEzf7pjlA17Bo"
title="YouTube video player" frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen></iframe>
</div>
</div>

<div class="card-detail" id="card-detail9">
<h2>Gebote abgeben</h2>
<p>
Der Benutzer kann die Gebote abgeben, sobald der Abstimmungszeitraum begonnen hat. Der Benutzer sieht die
Produkte und Anzahl an Runden, die zuvor konfiguriert wurden.</p>
<p>
Solange noch keine Runde ermittelt wurde, kann der Benutzer seine Gebote neu abgeben.
</p>
<div class="video">
<iframe width="1120" height="630"
src="https://www.youtube-nocookie.com/embed/2vwVpV3bP2E?si=Lk8bl1_gvWy0Pjrc"
title="YouTube video player" frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen></iframe>
</div>
</div>

<div class="card-detail" id="card-detail8">
<h2>Gebote für Benutzer abgeben</h2>
<p>Admins können im Namen der Benutzer Gebote abgeben.</p>
<div class="video">
<iframe width="1120" height="630"
src="https://www.youtube-nocookie.com/embed/2atIXa9w9Vo?si=nvKdPNolDDxLRHiq"
title="YouTube video player" frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen></iframe>
</div>
</div>

<div class="card-detail" id="card-detail7">
<h2>Runde ermitteln</h2>
<p>Sobald alle Gebote abgegeben wurden, ermittelt das System die Runde mit genügend Umsatz.</p>
<div class="video">
<iframe width="1120" height="630"
src="https://www.youtube-nocookie.com/embed/WrS7YvwuYy8?si=Fb4UcvrQCr2ywRKR"
title="YouTube video player" frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen></iframe>
</div>
</div>

<div class="card-detail" id="card-detail5">
<h2>Gebote exportieren</h2>
<p>Um die Gebote weiter verarbeiten zu können, können sie exportiert werden. Folgende Formate sind dabei
möglich:</p>
<ul>
<li><code>xlsx</code></li>
<li><code>csv</code></li>
<li><code>pdf</code></li>
</ul>
<div class="video">
<iframe width="1120" height="630"
src="https://www.youtube-nocookie.com/embed/lEmnAM9YGDk?si=rKpJ4Htowl9oRVUK"
title="YouTube video player" frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen></iframe>
</div>
</div>

<div class="card-detail" id="card-detail6">
<h2>Benutzer aus Beitragsrunde entfernen</h2>
<p>Um irrtümlich hinzugefügte Benutzer zu entfernen, kann der Admin die Benutzer aus der Beitragsrunde
entfernen.</p>
<div class="video">
<iframe width="1120" height="630"
src="https://www.youtube-nocookie.com/embed/H09DlgM6Gvc?si=REBI3vXW9rjS0nEO"
title="YouTube video player" frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen></iframe>
</div>
</div>
</div>

<script src="script.js"></script>
<script src="https://kit.fontawesome.com/e29d3151fd.js" crossorigin="anonymous"></script>
</body>
</html>
18 changes: 18 additions & 0 deletions docs/script.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
function toggleCard(cardNumber) {
const icon = document.getElementById('icon' + cardNumber);
icon.classList.toggle('rotated');

const allDetails = document.querySelectorAll('.card-detail');
allDetails.forEach(detail => detail.style.display = 'none');

const allIs = document.querySelectorAll('.cards .card-header span i');
allIs.forEach(i => {
if (icon.id === i.id) {
return;
}
i.classList.remove('rotated');
});

const cardDetail = document.getElementById('card-detail' + cardNumber);
cardDetail.style.display = 'block';
}
63 changes: 63 additions & 0 deletions docs/styles.css
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
body {
font-family: Arial, sans-serif;
line-height: 1.6;
}

h1 {
text-align: center;
background-color: #f4f4f4;
padding: 5px;
border-radius: 15px;
width: 50%;
margin: 20px auto;
}

.container {
display: flex;
}

.cards {
width: 33%;
}

.card-header h2 {
cursor: pointer;
background-color: #f4f4f4;
margin-bottom: 10px;
padding: 5px;
border-radius: 5px;
box-shadow: 0 2px 5px rgba(0, 0, 0, 0.2);
}

.card-detail {
display: none;
width: 67%;
padding: 20px;
margin: 20px;
border-left: 1px solid gray;
background-color: #f4f4f4;
margin-bottom: 10px;
border-radius: 5px;
box-shadow: 0 2px 5px rgba(0, 0, 0, 0.2);
}

.rotated {
transform: rotate(-90deg);
-webkit-transform: rotate(-90deg);
}

.video {
display: block;
margin-left: auto;
margin-right: auto;
}

.caution {
padding-left: 10px;
padding-right: 10px;
background-color: #fffeee;
border-radius: 5px;
border: 1px solid gray;
margin: auto;
font-weight: bold;
}
Binary file removed storage/app/assets/UserImportTemplate.xlsx
View file
Binary file not shown.

0 comments on commit 60cee3c

Please sign in to comment.