Willkommen zum offiziellen Repository des SVWS-Servers (Schulverwaltungssoftware Nordrhein-Westfalen). Dieses Repository enthält den Code für den Server, der die Verwaltung und Speicherung schulischer Daten ermöglicht.
Der SVWS-Server ist ein zentraler Bestandteil der Schulverwaltungssoftware Nordrhein-Westfalen (SVWS).
Das Projekt hat sich das Ziel gesetzt, für die Zukunft eine plattformunabhängige Web-Applikation für die Schulen in NRW zu schaffen.
Dieses Repository enthält den Quellcode des Servers sowie Anleitungen zur Installation und Nutzung.
Weitere Informationen findest du in der offiziellen Dokumentation.
Das Handbuch für den Webclient werden wir hier aufbauen: Anwenderhandbuch
Die fertigen (Pre-) Releases zur Installation findest du hier: https://github.com/SVWS-NRW/SVWS-Server/releases
Hier findet man den zu den Releases gehörigen Docker-Container: https://hub.docker.com/r/svwsnrw/svws-server
Die npm-Packages, die auch in anderen Projekten verwendet werden dürfen: https://www.npmjs.com/~svws-nrw
Maven-Packages, ebenfalls zur freien Verwendung: https://central.sonatype.com/namespace/de.svws-nrw
Stelle sicher, dass die folgenden Voraussetzungen erfüllt sind, bevor du mit der Installation beginnst:
- Git
- Java 21
- Gradle 8 (enthalten)
- MariaDB 10.6 oder höher
- Klone das Repository:
git clone https://github.com/SVWS-NRW/SVWS-Server.git
- Navigiere in das Projektverzeichnis:
cd SVWS-Server - Richte die
svwsconfig.jsonund den Keystore ein, gemäß der Einrichtungsanleitung. - Erstelle das Projekt mit Gradle:
./gradlew build
- Starte den Server:
./SVWS-Server/svws-server-app/startserver.sh
Beispiele für die Installation der Entwicklungsumgebung: https://doku.svws-nrw.de/Entwicklungsumgebungen/
Nach dem Starten des Servers kannst du über https://localhost auf die Weboberfläche zugreifen. Weitere Konfigurationsoptionen und Anleitungen findest du in der offiziellen Dokumentation.
Beiträge zur Verbesserung des SVWS-Servers sind willkommen. Um beizutragen, folge bitte diesen Schritten:
- Forke das Repository.
- Erstelle einen neuen Branch:
git checkout -b benutzername/NeuesFeature
- Nimm deine Änderungen vor und committe sie:
git commit -m "Beschreibe deine Änderungen" - Push deinen Branch:
git push origin benutzername/NeuesFeature
- Erstelle einen Pull-Request.
Bitte lies die Beitragsrichtlinien für weitere Details.
Dieses Projekt ist lizenziert unter der BSD 3-Clause Lizenz. Weitere Informationen findest du in der LICENSE-Datei.
Wenn du Fragen oder Anmerkungen hast, eröffne bitte ein Issue auf GitHub.
Vielen Dank für deinen Beitrag zur Verbesserung des SVWS-Servers!