Adonais0 / student_explorer

Tool used by Academic advisors to access student weekly performance

Student Explorer

Development Environment

Setup

1. Install Docker
2. Follow steps in the "Run development server" section below.

Run development server

• cd student_explorer
• docker-compose down; docker-compose build; docker-compose up -d
• Browse to http://localhost:2082/
• Login as individual advisors using their lower-case first name as username/password (e.g.: burl/burl)
• Student with useful data: http://localhost:2082/students/grace/

Using the Django Debug Toolbar

For the Django Debug Toolbar to work in development, please add the following in student_explorer > local > settings_override.py

• INSTALLED_APPS += ('debug_toolbar',)
• MIDDLEWARE_CLASSES += ('debug_toolbar.middleware.DebugToolbarMiddleware',)
• DEBUG_TOOLBAR_PATCH_SETTINGS = False
• INTERNAL_IPS = ['10.0.2.2']

Note on settings

By default manage.py looks for the student_explorer.local.settings_override module. This file is created manually as documented in the setup steps above.

By default wsgi.py (which is used by start.sh) looks for the student_explorer.settings module. This file is versioned as part of this repository.

This behavior can be changed for both manage.py and wsgi.py by setting the DJANGO_SETTINGS_MODULE environment variable.

Cron JOB

Users and files are loaded now with the cron job. This is run on a separate pod in Openshift when the environment variable IS_CRON_POD=true.

Crons are configured in this project with django-cron. Django-cron is executed whenever python manage.py runcrons is run but it is limited via a few environment variables.

The installation notes recommends that you have a Unix crontab scheduled to run every 5 minutes to run this command. https://django-cron.readthedocs.io/en/latest/installation.html

For local testing, make sure your secrets are added and your VPN is active. Then run this command on a running container to execute the cronjob

docker exec -it student_explorer /bin/bash -c "python manage.py migrate django_cron && python manage.py runcrons --force"