From 8e0b5f88102fca61efe381bf39c38672b74d5338 Mon Sep 17 00:00:00 2001 From: reynir Date: Wed, 4 Mar 2020 13:44:19 +0000 Subject: [PATCH] Add 'README.md' --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2c4409a --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# Mellemfolk bar intranet +This is a web app for Mellemfolk in Aarhus. It is written in Python using Django. The django app provides features such as: + +* An overview who's on shift today, +* their contact information such as phone number and email, +* a log book to write messages to other volunteers and staff with Slack integration, +* an easy way to check what your cleaning task is and documenting when the task has been done. + +## `secret_settings.py` +The django app depends on a file `secret_settings.py` which contains secrets for Planday as well as Slack. + +## Installation +**TODO:** more precise instructions coming (hopefully) soon. \ No newline at end of file