Merge pull request #160 from UniRegensburg/prepare-deployment

Prepare deployment

README.md

@@ -2,25 +2,50 @@
   <img src="https://user-images.githubusercontent.com/44339207/189524995-fa130521-2814-493b-8998-f54b630e8a88.png" width="100%">
 </p>
 
-<b>Aktuelle Version verfügbar unter:</b> https://markusbink.github.io/basisdokument-implementierung/
+Please note - This repository is a fork with continued development of https://github.com/markusbink/basisdokument-implementierung
 
-# Basisdokument
+## About
 
-*Course: MEI-M26 Projektseminar (P-(D-)36633 Praxisseminar) im M.Sc. Medieninformatik, Sommersemester 2022*
+This application is part of a research project at the University of Regensburg in cooperation with the Ministries of Justice in Bavaria and Lower Saxony.
+The project serves to gain insights into the digital possibilities of formally structuring party submissions in civil proceedings.
+The Chair of Media Informatics supported the project by developing a prototype that was piloted and tested in four courts from January 2023 to June 2024.
 
-*Course Instructors: Prof. Dr. Christian Wolff, M.A. Victoria Böhm, M.Sc. Jakob Fehle*
+This app enables lawyers and judges to create their previous analogue correspondence in a digital environment.
+It offers a variety of useful features that aim to ease the process of working on cases while also making the process more time efficient.
 
-*Projectteam: Markus Bink, Martina Emmert, Nils Constantin Hellwig, Michelle Lanzinger, Nicole Schönwerth*
+The app is based on previous student work as part of a project seminar in the Master's programm of Media Informatics by [Hahn, Röhr & Sautmann (2021)](https://github.com/kindOfCurly/PS-Basisdokument/wiki/Projekt-Log) and [Freisleben, Schwarz & Zels (2021)](https://elearning.uni-regensburg.de/mod/resource/view.php?id=2172773).
+The first version of this app was also developed by a group of students: [Bink, Emmert, Hellwig, Lanzinger, Schönwerth](https://github.com/markusbink/basisdokument-implementierung/wiki).
 
-## About
+All requirements have been merged into one application that can be used by all parties (Plaintiff, Defendant, Judge).
+The app allows them to create and edit a digital document called "Basisdokument".
+
+**Get in touch with our application here: https://app.parteivortrag.de/**
+
+Further information about the project and documentation of the features can be found at the projct homepage: https://www.uni-regensburg.de/forschung/reallabor-parteivortrag-im-zivilprozess/startseite/index.html
+
+## Members of the project group
+
+The following people are or were involved in the research project at the Chair of Media Informatics (University of Regensburg):
 
-This app enables lawyers and judges to create their previous analogue correspondence in a digital environment. It offers a variety of useful features that aim to ease the process of working on cases while also making the process more time efficient. The app is based on the works of the last semester by [Hahn, Röhr & Sautmann (2021)](https://github.com/kindOfCurly/PS-Basisdokument/wiki/Projekt-Log) and [Freisleben, Schwarz & Zels (2021)](https://elearning.uni-regensburg.de/mod/resource/view.php?id=2172773) The division of the prototypes from previous semesters was discarded due to the newly emerged requirements. All previous and new requirements have been merged into one application that can be used by all parties (Plaintiff, Defendant, Judge). The app allows them to create and edit a "Basisdokument". The current list of features can be seen in the corresponding [Wiki](https://github.com/markusbink/basisdokument-implementierung/wiki/07-Beschreibung-der-Anwendung).
+_Prof. Dr. Christian Wolff, Victoria Böhm, Jakob Fehle, Julia Sageder, Martina Emmert, Marie Sautmann_
 
-## Motivation
+## Original development setting (2022)
 
-The working group "Modernization of Civil Procedure" has "extensively examined how new technical possibilities can be used in civil procedure in order to make court procedures more citizen-friendly, efficient and resource-saving". [[1]](https://www.brak.de/newsroom/newsletter/nachrichten-aus-berlin/2021/ausgabe-2-2021-v-2712021/modernisierung-des-zivilprozesses-diskussionspapier-der-olg-praesidenten/)
-The working group's proposal is a digital document that serves to structure the party speech and eases the communication process between parties.
+_Course: MEI-M26 Projektseminar (P-(D-)36633 Praxisseminar) im M.Sc. Medieninformatik, Sommersemester 2022_
+
+_Course Instructors: Prof. Dr. Christian Wolff, M.A. Victoria Böhm, M.Sc. Jakob Fehle_
+
+_Projectteam: Markus Bink, Martina Emmert, Nils Constantin Hellwig, Michelle Lanzinger, Nicole Schönwerth_
+
+For further information see the original repository and its Wiki: https://markusbink.github.io/basisdokument-implementierung/
 
 ## Running the project locally
 
-To get started, download the project, `cd` into the root directory and install all dependencies using `npm install --force` or any other package manager of your choosing. After all dependencies have successfully been installed, you can run `npm start` in your terminal which opens the app in your browser under the following URL [http://localhost:3000](http://localhost:3000).
+To get started, download the project, `cd` into the root directory and install all dependencies using `npm install --force` or any other package manager of your choosing.
+After all dependencies have successfully been installed, you can run `npm start` in your terminal which opens the app in your browser under the following URL: [http://localhost:3000](http://localhost:3000).
+If you get errors doing this, remember to update to the latest version of npm and node.
+
+## Continous integration
+
+This repository uses github actions to automatically deploy changes.
+`dev` is deployed to https://test.parteivortrag.de/ and `main` is deployed to https://app.parteivortrag.de/.