From 74e23cd7f78866683b4407ad4c86ad8a0b70b6f3 Mon Sep 17 00:00:00 2001
From: Mo8it <mo8it@proton.me>
Date: Sun, 2 May 2021 18:55:40 +0200
Subject: [PATCH] Added README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e84e4e1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# Requirements
+You need to have Python 3 and Poetry installed. To install Poetry, follow the instructions [here](https://python-poetry.org/docs/#installation).
+
+# Start server
+Every following instructions has to be followed every time before starting the server if not mentioned otherwise.
+
+Navigate to the directory `advlabdb` where the repository is cloned and run:
+
+```
+git pull
+```
+
+to pull the latest changes from the remote repository. Then run:
+
+```
+poetry install
+```
+
+to install (or update) all needed packages to the virtual environment. Now enter the virtual environment:
+
+```
+poetry shell
+```
+
+If you are starting the server for the first time or you want to drop and recreate the database then run:
+
+```
+python testDB.py
+```
+
+This creates the database with some elements for testing.
+
+Now you can start the server by running:
+```
+python run.py
+```
+
+This command will print out the URL for accessing the local server. For example:
+
+```
+* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
+```
+
+This URL leads to the home page. Now login and then navigate to `/admin` as shown on the home page after login.
+
+## Pay attention to:
+- If you create a semester, then you have to set it as the active semester for you as current user. For that, navigate to the home page / (or click on the `Links` drop down menu in the navigation bar then `Home`). Then click on the `Semester` drop down menu in the navigation bar to choose the semester you have created to be the active one. Then navigate back to `/admin`. This will be fixed soon.
+- Many "model views" are not done yet. There is still a lot to be done.
\ No newline at end of file