Add 'README.md'

This commit is contained in:
reynir 2020-03-04 13:44:19 +00:00
parent e33f615205
commit 8e0b5f8810
1 changed files with 13 additions and 0 deletions

13
README.md Normal file
View File

@ -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.