onaio / wb-composting Goto Github PK

View Code? Open in Web Editor NEW

1.0 35.0 2.0 5.66 MB

World Bank Uganda Composting

Python 15.54% CSS 17.95% JavaScript 66.16% Shell 0.35%

wb-composting's Introduction

WBComposting README

Run with Vagrant

Installing

Download Install VirtualBox
Download Install Vagrant
Install Ansible, preferably from source
```
cd ~/
git clone git://github.com/ansible/ansible.git
cd ./ansible
source ./hacking/env-setup
```
If you don’t have pip installed in your version of Python, install pip (No harm running it if its already installed):
```
sudo easy_install pip
```
Install Ansible's requirements
```
sudo pip install paramiko PyYAML jinja2 httplib2
```
Change back into the project's directory
```
cd /path/to/this/project
```

Clone the Ona playbooks repo (into a different directory)

git clone [email protected]:onaio/playbooks.git ~/playbooks

Make a symbolic link to the playbooks directory
```
ln -s ~/playbooks ansible
```
Bring up the virtual machine with Vagrant
```
vagrant up
```
NOTE: This will keep the virtual machine running until you halt it via vagrant halt
Provision using ansible
```
vagrant provision
```
NOTE: To update to the latest version at any time, run the provision command again.

Running

ssh into the virtual machine
```
vagrant ssh
```
Change into the project's directory
```
cd /vagrant
```

Activate the virtual environment

source ~/.virtualenvs/composting/bin/activate

Run the server
```
pserve development --reload
```
Load the app in your browser at http://192.168.33.15:6543/

You can now make edits from your host (read OSX) and have them reflected when you refresh the browser.

wb-composting's People

Contributors

Stargazers

Watchers

wb-composting's Issues

Actionable items count should probably take into account the filter criteria

While viewing a monthly registry e.g. monthly density, we always show the number of un-approved items in the navigation regardless of period. The result is that when viewing by e.g. June but an un-approved record exists for May, the navigation shows a count of 1 while loading the page you don't see any records.

Perhaps the best fix would be to show data grouped by month, similar to how its done within the daily waste register.

Dont allow daily waste approval until a monthly density is available

Because the dialy waste's tonnage calculation depends on the monthly density, it was suggested that daily wastes should not be approvable unless the monthly density has been determined.

This adds a layer of complexity and might not make much sense, because, as long as the data in the daily waste is valid, it shouldn't matter what the monthly density is. If there is a problem with the monthly density, it should be fixed within the monthly density.

Don't allow approval of monthly waste density record if skip type is invalid

Show actual Environmental officer and site manager names in municipalityi list view

Give the user a hint on why a submission cannot be approved

There are 2 possible reasons why a daily waste submission cannot be verified:

If the skip type is invalid, the solution is to edit the submission and fix the skip type
If the monthly density cannot be calculated e.g. when we dont have the reuqired no. of monthly density records.

In both cases, we simply don't allow approval by not displaying the button. The user has no clue why the submission cannot be approved so we need a way of hinting why that is and allowing them to fix it.

The Submission.can_approve function was initially meant to figure out whether or not to show the button, I think we should separate the logic that determines if the button should be shown from whether the submission has issues that need to be fixed before it is approved.

Tablesaw on municipal table bug on resizing

Save or display times in EAT

Currently, the data collection time is in EAT while the _submission_time is in Eastern Time Zone (NY) so submission time is always earlier than record capture time

Show "No results" instead of blank tables

Taking the Monthly Solid Waste Composition register as an example, it shows a blank table when there are no records to show. Use a simple for ... else within the jinja template to do this.

Edit functionality

In cases where the data needs to be edited, once the data is submitted back into ona.io, the platform will update the record and then send the JSON to our dashboard. The dashboard currently has no way of distinguishing duplicates from new data. To allow updates, we will make use of the _id field within the JSON payload. If a record with a matching _id exists, update the JSON with the new data.

For better performance, add an _id field to to the submissions schema for lookups.

Maintain filter across POSTs

When you e.g. approve a record from a filtered view, the response returns to an un-filtered state, which is a bit unnerving.

Show cross-sectional area when editing a skip type

This is just a convenience feature

Clear test data

Clear test data from the dashboard in readiness for launch

Dont allow daily waste approval if the referenced skip type is not valid

If the skip within a daily waste record is not a compressor, its volume is determined from the skip type. Since the skip types are created from the dashboard, a user might mistakenly enter an invalid skip type. If the skip type does not exist within the municipality, the records approval should not be allowed until the skip type is resolved, likely via editing the record.

Make side-nav a block within base to be filled in by municipality template

This will remove some duplication between child templates