README improvements

* removed dependency infos - those are in requirements.txt
* added info on mail attachments
* removed obsolete /intern endpoint
This commit is contained in:
Andreas Gohr 2025-10-20 11:39:21 +02:00
parent 7365218adb
commit e8848b0c97
1 changed files with 17 additions and 23 deletions

View File

@ -25,7 +25,6 @@ run the development server with
access via
http://localhost:8000/
http://localhost:8000/intern/ (login required)
http://localhost:8000/admin/ (login reqiured)
## docker compose development setup
@ -44,7 +43,6 @@ Create your superuser account with
You can access the application via
http://localhost:8000/
http://localhost:8000/intern/ (login required)
http://localhost:8000/admin/ (login required)
## additional admin functionality
@ -56,28 +54,24 @@ entries to a csv file
- There is a new button in the bottom of every Project to "save as new"
## versions used in development
## mail attachments
asgiref==3.2.10
Django==3.1.2
gunicorn==20.0.4
mysqlclient==2.1.1
sqlparse==0.4.3
whitenoise==6.2.0
asgiref==3.2.10
Authlib==1.2.1
certifi==2023.7.22
cffi==1.16.0
chardet==5.2.0
charset-normalizer==3.3.0
cryptography==41.0.4
idna==3.4
pycparser==2.21
pytz==2023.3.post1
requests==2.31.0
six==1.16.0
typing_extensions==4.8.0
urllib3==2.0.6
For all mails, attachments can be defined as URLs. These URLs are fetched and chached when sending the mail and attached to the mail.
Configuration is done via the `ATTACHMENT_URLS` setting. Attachments can be set for user (`RECIPIENT_APPLICANT`) and staff (`RECIPIENT_STAFF`) mails. The following mail types exist:
* `TYPE_BIB` Bibliotheksstipendium
* `TYPE_ELIT` eLiteraturstipendium
* `TYPE_SOFT` Softwarestipendium
* `TYPE_MAIL` E-Mail-Adresse
* `TYPE_IFG` Kostenübernahme IFG-Anfrage
* `TYPE_LIT` Literaturstipendium
* `TYPE_LIST` Mailingliste
* `TYPE_TRAV` Reisekosten
* `TYPE_VIS` Visitenkarten
* `TYPE_PROJ` Projektförderung
For further details see `foerderbarometer/settings.py`
## testing