README.md aktualisiert

README.md

@@ -1,61 +1,67 @@
-# eva
+# eva
-
+
-A simple tool for on- and offboarding people in a mid sized organisation.
+A simple tool for on- and offboarding people in a mid sized organisation.
-
+
-"EVA" is an german acronym for "Eintritt, Veränderung, Austritt",
+"EVA" is an german acronym for "Eintritt, Veränderung, Austritt",
-meaning "Onboarding, Change, Offboarding"
+meaning "Onboarding, Change, Offboarding"
-
+
-# development
+# development
-
+
-- install gettext for instance via "apt install gettext" for translations
+- install gettext for instance via "apt install gettext" for translations
-
+
-- set up a virtual environment with virtualenvwrapper or some other
+- set up a virtual environment with virtualenvwrapper or some other
-environment managing tool
+environment managing tool
-
+
-- use this environment and do
+- use this environment and do
-
+
-    pip install django django-multiselectfield django-formtools django-allauth
+    pip install django django-multiselectfield django-formtools django-allauth requests whitenoise
-
+
-- clone this repository
+- clone this repository
-
+
-- ln -sr eva/settings_development.py eva/settings.py
+- ln -sr eva/settings_development.py eva/settings.py
-
+
-- initialise your database with
+- initialise your database with
-
+
-    python manage.py migrate
+    python manage.py migrate
-
+
-- start your development server with
+- You need to add oauth information in the django backend via .../admin in "Social Accounts"
-
+
-    python manage.py runserver
+    python manage.py createsuperuser
-
+
-# oauth
+- start your development server with
-
+
-- You need to add oauth information in the django backend via .../admin in "Social Accounts"
+    python manage.py runserver
-
+
-# production
+- Configure OAuth: 
-
+
-- you can use gunicorn as server for example instead of the django development server.
+   Access the admin interface at http://127.0.0.1:8000/admin
-
+   Login with your superuser credentials  
-- we use whitenoise for serving static files
+   Go to ‘WEBSITE ANZEIGEN’
-
+
-- we still use the development SQLITE database from django
+# production
-
+
-do the following in the project main directory:
+- you can use gunicorn as server for example instead of the django development server.
-
+
-  ln -sr eva/settings_production.py eva/settings.py
+- we use whitenoise for serving static files
-
+
-edit /secrets.json to contain something similar to
+- we still use the development SQLITE database from django
-
+
-  {
+do the following in the project main directory:
-    "SECRET_KEY": "THIS IS ANOTHER SECRET!"
+
-  }
+  ln -sr eva/settings_production.py eva/settings.py
-
+
-run the following commands:
+edit /secrets.json to contain something similar to
-
+
-  python3 manage.py migrate
+  {
-  python3 manage.py collectstatic
+    "SECRET_KEY": "THIS IS ANOTHER SECRET!"
-  django-admin compilemessages
+  }
-
+
-server starts with
+run the following commands:
-
+
-  export PYTHONUNBUFFERED=TRUE; nohup gunicorn --forwarded-allow-ips="*" -b '0:8000' eva.wsgi &> logfile &
+  python3 manage.py migrate
+  python3 manage.py collectstatic
+  django-admin compilemessages
+
+server starts with
+
+  export PYTHONUNBUFFERED=TRUE; nohup gunicorn --forwarded-allow-ips="*" -b '0:8000' eva.wsgi &> logfile &