Skip to content

Latest commit

 

History

History
90 lines (66 loc) · 3.94 KB

README.md

File metadata and controls

90 lines (66 loc) · 3.94 KB

KanuControl

KanuControl ist noch in der Entwicklung und läuft noch nicht!

KanuControl ist eine Anwendung zur Beantragung und Abrechnung von Zuschüssen aus dem Kinder-, Jugend und Freizeitplan (KJFP) vom Landessportbund NRW (LSB NRW). Die Anträge und Abrechnungen werden von der Geschäftsstelle des KanuVerbandes NRW (KVNRW) verarbeitet.

Der generelle Ablauf besteht in den folgenden Schritten:

  • Anlegen eines Vereins, falls noch nicht vorhanden
  • Eintragen von Mitglieder in diesen Verein

Antragstellung:

  • Anlegen einer Jugend-Veranstaltung, für die Zuschussmittel beantragt werden sollen. Dies ist dann die aktive Veranstaltung.
  • Ausgabe der Antragsformulare als bearbeitbare PDF-Formulare. Dort können eventuell fehlende Angaben manuell nachgetragen werden.

Durchführung der Veranstaltung

  • Eintragen der Teilnehmer dieser Veranstaltung
    • Falls die Teilnehmer noch nicht in der Mitgliedertabelle enthalten sind, werden sie angelegt und automatische der aktiven Veranstaltung als Teilnehmer zugeordnet.

Abrechnung:

  • Eintragen der Einnahmen und Kosten der Veranstaltung
  • Eventuell Erfassen von Reisekosten (i.d.R. Fahrtkosten von PKW´s)
  • Ausgabe der Abrechnungsdokumente als PDF
    • Deckblatt
    • Erhebungsbogen (das sind mehrere Blätter mit statistischen Auswertungen)
    • Teilnehmerliste

KanuControl - Technik

Das Programm ist eine Client-Server Anwendung, die mit jedem Internet-Browser auf PC, Tablett oder auch Smartphone funktioniert. Einzige Vorraussetzung ist eine stabile Internetverbindung.

Die Daten werden auf einem Server im Internet in einer mySQL Datenbank gespeichert.

Das Programm unterstützt bei der Erfassung der Veranstaltung, der Teilnehmer, der Einnahmen und Ausgaben. Aus diesen Daten werden die erforderlichen PDF Formulare erzeugt bzw. ausgefüllt. Im wesentlichen sind das:

  • Anmeldeforumular
  • Abrechnungs-Deckblatt
  • Teilnehmerliste
  • Erhebungsbogen
  • eventuell Reisekosten

Frontend

Das Frontend ist eine REACT Anwendung, die mit einem Java-Backendserver kommuniziert. Es wird TypeScript verwendet. Als Entwicklungsumgebung wird VS Code eingesetzt.

Das Frontend lauft im Vite Framework. Vite ist ein modernes Build-Tool, das auf Geschwindigkeit und Effizienz ausgelegt ist, insbesondere bei der Arbeit mit JavaScript-Frameworks wie React.

Zur Darstellung des User-Interface wird Tailwind eingesetzt.

Backend

Der Backendserver ist eine Spring Boot Anwendung. Spring Boot Version 3.2.2, Java Version 17. Dependency Mgmt mit Maven. Das Datenbank Schema wird über Hibernate im Backend definiert. In mySQL wird nur die Datenbank selber einmal angelegt.

Die Spring Boot Anwendung läuft unter Java17.

Workflow

1.	React Frontend sends an HTTP request →
2.	Spring Boot Controller handles the request →
3.	Service Layer processes the logic →
4.	Mapper converts DTO ↔ Entity →
5.	Repository interacts with MySQL DB →
6.	Response flows back through the layers to the frontend.

Schema von KanuControl

Es gibt verschiedene Tabellen (Entities), die fast alle über n:m Beziehungen (relationships) verbunden sind. Jede Tabelle hat einen Primarykey, der keine inhaltliche Bedeutung hat.

In der Version 1.0 gibt es die folgenden Tabellen:

  1. Verein
  2. Person
  3. Veranstaltung
  4. Veranstaltungstyp (z.B. FM, JEM, Bildung, Großveranstaltung)
  5. Funktion (Jugendwart, Sportwart, ...)
  6. Finanzen => Veranstaltung (1:1)

Weiterhin gibt es die Beziehungen:

  1. Mitglied = Verein : Person (n:m) mit Attributen (Funktion und Hauptverein)
  2. Teilnehmer = Veranstaltung : Person (n:m)

Mandantenfähigkeit

In der Version 2.0 ist geplant, dass die Nutzerdaten über eine Benutzerverwaltung getrennt werden. Damit wird sichergestellt, dass jeder Kanuverein nur seine Daten sehen und verändern kann.