Commit 04522404 authored by Alan's avatar Alan

Update documentaiton for handover and archiving

parent 00894496
Pipeline #12144 passed with stages
in 21 minutes and 51 seconds
# Humanitarian Information Dashboard Architecture
## Overview
The Internews Humanitarian Information Dashboard (HID) allow spreadsheets of message (eg. text messages, rumours etc) to be imported, edited, searched and visualised.
It has a flexible database structure that allows arbitrary tagging and data to be imported with the message.
## General Architecture
The Internews HID application is written in Django.
### API
It uses the **DjangoREST framework** to provide an API directly to the data. All of the internal data access is done through the API rather than directly to the database. See the `transport` app.
### Flexible Database
The application has a number of features that are configured or stored in the database rather than coded in the structure which in principle allows them to be modified by an admin user in the django admin user interface.
For instance the specification of spreadsheet data formats used by the spreadsheet importer can be specified in the admin interface.
Also the data itself uses two mechanisms to allow flexibility in data storage. It has the concept of Tags and KeyValue pairs.
The tags belong to taxonomies that are specified through the admin interface. A taxonomy can be closed (in which case all values that a tag of that taxonomy can take must be specified) or they can be open in which case the importer will create a new tag in the database if it comes across a new entry in the imported data. This means that taxonomies of tags that can be attached to message records are configurable and not hard-coded in the database.
Similarly there are KeyValue pairs. Instead of importing data into a set database column, they allow and administrator to configure "virtual" columns by specifying a spreadsheet column as a KeyValue type. Additionally the importer can import any spreadsheet columns that have not been specified in the importer specification into KeyValue pairs.
## CSS / LESS
The CSS is auto-generated from .less files.
There should be no need to manually run compass.
### InterNews HID theme
LESS files reside in internewshid/internewshid/media/less
### Bootstrap 3.3.5
We are using Bootstrap v3.3.5 (http://getbootstrap.com) as our base styling.
See /media/bootstrap/less/bootstrap.less for the configuration, not all files are imported.
We do not load glyph-icons for example.
### Dashboard
Has its own css file dashboard/dashboard.css, loaded in assets.py
### Fontawesome icons
Fontawesome 4.3.0 is loaded by assets.py
Source files: /mediafonts/font-awesome-4.3.0/
## Adding a new spreadsheet format
Create a new `SheetProfile` object with a `profile`, for example:
......@@ -133,3 +182,11 @@ The `Settings` are specified in a blob of JSON with the following format:
## Importing a spreadsheet
Importing a spreadsheet will create ``Item`` objects (see `data_layer/models.py` via the ``transport`` app).
## Next steps for future development
The spreadsheet importer was originally developed to handle the export of form based survey tools like KOBO (eg. for the Ebola crisis in Liberia and Bangladesh). Consequently it is deliberately unforgiving of any deviations in the specified import format.
Later it was configured for use in DRC, South Sudan and for the COVID19 crisis, where data had been manually entered into spreadsheets. The importer could be improved for this scenario by being more tolerant. For instance it could force standard capitalisation and strip whitespace. It could also better report importing errors and allow for correction and re-importing workflow.
The importer specification was designed to be flexible without having to change the code so it is set in the admin interface. It is exposed in the admin as an editable JSON structure. This isn't as user friendly as it could be and also it complicates the code significantly. The importer specification is a relatively technical bit of configuration and was not configured by admin users. Instead it was developers who edited it. It would be worth reviewing whether editing the importer specification in the admin interface is the best option or if editing it as source code would be better.
# How to set up the Internews Humanitarian Information Dashboard on a Ubuntu 14.04 environment
# How to set up the Internews Humanitarian Information Dashboard on a Ubuntu 18.04 environment
This document provides instructions on deploying the [Internews Humanitation
Information Dashboard](https://git.coop/aptivate/client-projects/internewshid/) on a [Ubuntu
......@@ -9,7 +9,7 @@ Familiarity with the command line is required.
## Development environment setup
These instructions allow you to setup the HID on a local development machine,
based on the desktop edition of Ubuntu 14.04. This setup does not require a web
based on the desktop edition of Ubuntu 18.04. This setup does not require a web
server, as it is for development only and instead uses Django's build in
server.
......@@ -59,6 +59,15 @@ download the application's dependencies and deploy the project locally:
pip install pipenv && pipenv sync --dev
```
Note there are a number of different settings files (eg. `local_settings.py.covid19-dev`) and you will want to set your local settings to the appropriate settings file using a symbolic link, depending on what you are doing. For instance if you are doing development on the COVID19 version on your local machine you want to use `local_settings.py.covid19-dev`. The generic development settings are `local_settings.py.dev` which is what the following command uses (from the set of commands above). You can change this command to the appropriate file.
```sh
ln -srf internewshid/local_settings.py.dev internewshid/local_settings.py
```
When you deploy to your production server you will want to use the appropriate production settings file.
### Load the database fixtures
The dashboard is configured through the database. This is most easily set up through
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment