Merge branch 'develop' into billing_module

README.md

@@ -1,39 +1,63 @@
-# ERRMS
+# Einsatz Online
 Build status (develop branch): 
 [![builds.sr.ht status](https://builds.sr.ht/~anghenfil.svg)](https://builds.sr.ht/~anghenfil?search=)
 ![project status](https://www.repostatus.org/badges/latest/wip.svg)
 
-## About ERRMS
-* ERRMS stands for **E**mergency **R**esponse and
- **R**escue **M**anagement **S**ystem
-* application for fire departments, humanitarian aid organisations and similar
-* organise member data, events/operations and other resources
+## Über Einsatz Online
+Einsatz Online ist eine Plattform für Hilfsorganisationen, Feuerwehren und ähnlichen ehrenamtlichen Strukturen und soll Verwaltungsaufgaben erleichtern & digitalisieren. Dazu zählt unter anderem die Verwaltung von Personaldaten, Fahrzeugen und geplanten Einsätzen.
+Künftig soll Einsatz Online zudem die Alarmierung und Einsatzführung vor Ort unterstützen.
 
-Checkout our presentation: https://md.kabi.tk/p/H1nWPbueL
+## Eigenschaften
+* vollständig & für immer Open Source (APGLv3)
+* modulare Software
+* starkes Rechtesystem um Privatsphäre & Daten zu schützen
 
-## characteristics
-* fully open source (APGLv3)
-* modular software
-* strong focus on data privacy & data security
-* provides feature-rich API for integration
-* multilingual, easy to translate software
-* strong, precise permission system
+## Mitmachen
+Sehr gerne könnt ihr mich bei diesem Projekt unterstützen. Das untenstehende Developer Setup hilft euch, eine Grundinstallation von Einsatz Online einzurichten. Ich freue mich über Pull Requests oder Issues!
 
-## How to contribute
-* You can contribute by signing pull requests and issues or programming!
-* Get in contact (Matrix: #errms@matrix.anghenfil.de) and check our website errms.dev and our project management tool: pm.errms.dev
 
+## Developer Setup
+* Voraussetzungen: [Rust Toolchain](https://rustup.rs/), [PostgreSQL Server](https://www.postgresql.org/)
+* Clone dieses Git Repository
+* Verzeichnis betreten
+* Kopiere config/default.toml nach config/development.toml
+* "connection_string" in der Konfiguration entsprechend anpassen. z.B. ```postgresql://postgresuser:password@localhost:5432/postgres```
+* Diesel CLI installieren: ```cargo install diesel_cli```
+* Diesel CLI Datenbank einrichten: ```diesel setup --database-url='CONNECTION_STRING_HERE'```
+* Datenbank einrichten: ```diesel migration run```
+* Mit [cargo build](https://doc.rust-lang.org/cargo/commands/cargo-build.html) Einsatz Online bauen
+* Mit [cargo run](https://doc.rust-lang.org/cargo/commands/cargo-run.html) Einsatz Online starten.
+
+## Dokumentation
+* Derzeit ist die Dokumentation noch nicht online verfügbar (coming soon).
+* Ihr könnt das Repository clonen & die [Rust Toolchain einrichten](https://rustup.rs/) und anschließend mit cargo doc die Dokumentation bauen. 
 
 ## Zeitplan/Timetable
 **Version 0.1:**
-* core system
-* Mitgliedsverwaltung/member management
+* core system (erledigt)
+* Mitgliedsverwaltung (erledigt)
+* Gruppen & Rollen (erledigt)
+* E-Mail Versand an Gruppen & Einheiten (erledigt)
 
-**Version 0.2:**
-* Fahrzeugverwaltung (nur Basisfunktionen) / vehicle management (limited functionality)
-* Einsatzverwaltung / event management
-* Veranstalterverwaltung / manage event organizer
+**Version 0.2: **
+* Fahrzeugverwaltung (nur Basisfunktionen) (erledigt)
+* Verwaltung geplanter Einsätze (erledigt)
+* Veranstalter verwalten (erledigt)
 
 **Version 0.3:**
-* Abrechnung / billing module
-* Fahrzeugverwaltung (erweitert) / expended vehicle management
+* Abrechnung geplanter Einsätze (WIP)
+* erweiterte Fahrzeugverwaltung
+* API für externe Anwendungen
+
+**geplant für spätere Versionen: **
+* eingenständiges Alarmierungssystem
+* Module für Einsatzführung (Lagekarte, Einsatztagebuch, Kräfteübersicht)
+* Exportfunktionen
+* Erweiterung Mitgliedermodul
+* Materialverwaltungsmodul
+* Übersetzungen
+* Docker Image
+
+## Kontakt Maintainer:
+* anghenfil
+* E-Mail/Delta-Chat: ares@anghenfil.de