From 24c43c543dd8bd32bd637627f1a1b8d6bd2ae5a8 Mon Sep 17 00:00:00 2001
From: Franz Dietrich <dietrich@teilgedanken.de>
Date: Thu, 29 Jun 2023 09:20:54 +0200
Subject: [PATCH] add a readme

---
 README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..619579a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,57 @@
+# Projektname
+
+Dieses Repository enthält ein Projekt-Setup, das Rust, SQLx, und Axum verwendet, um eine Webanwendung zu entwickeln. Das Projekt verwendet SQLite als Datenbank und enthält bereits den entsprechenden Code. In diesem Readme erfährst du, wie du das Projekt auf deinem System einrichten und starten kannst.
+
+## Voraussetzungen
+
+Vor der Verwendung dieses Projekts musst du sicherstellen, dass die folgenden Softwarekomponenten auf deinem System installiert sind:
+
+- Rust (Version XYZ): Installiere Rust, indem du die offizielle Rust-Website besuchst oder einen Paketmanager wie `rustup` verwendest.
+
+## Setup
+
+1. Klone das Repository auf deinen lokalen Computer:
+
+   ```bash
+   git clone https://git.uhle.cloud/dietrich/make_uhle.git
+   ```
+
+2. Navigiere in das Projektverzeichnis:
+
+   ```bash
+   cd make_uhle
+   ```
+
+3. Installiere die erforderlichen Abhängigkeiten und kompiliere das Projket:
+
+   ```bash
+   cargo build
+   ```
+
+4. (optional) Modifiziere die `.env`-Datei, sodass der Datenbankpfad deinen Wünschen entspricht. Wenn die Datei nicht existiert, wird sie automatisch erstellt (Ordner werden jedoch nicht angelegt).
+
+5. Führe das SQLx-Setup aus, um die SQLite-Datenbank einzurichten:
+
+   ```bash
+   cargo sqlx setup
+   ```
+
+6. Die erstellte Binärdatei liegt in `target/debug/make_uhle`
+
+## Starten der Anwendung
+
+Sobald das Setup abgeschlossen ist, kannst du die Anwendung starten, indem du den folgenden Befehl ausführst:
+
+```bash
+cargo run
+```
+
+Die Anwendung wird gestartet und ist über die Adresse `http://localhost:8035` erreichbar.
+
+## Beitrag leisten
+
+Wenn du einen Fehler findest oder einen Beitrag zu diesem Projekt leisten möchtest, freuen wir uns über Pull Requests. Bitte erstelle einen Fork dieses Repositories, führe deine Änderungen durch und reiche dann einen Pull Request ein.
+
+## Lizenz
+
+Dieses Projekt ist unter der MIT-Lizenz lizenziert. Weitere Informationen findest du in der [Lizenzdatei](LICENSE).
\ No newline at end of file