htbox / allready

This repo contains the code for allReady, an open-source solution focused on increasing awareness, efficiency and impact of preparedness campaigns as they are delivered by humanitarian and disaster response organizations in local communities.

Welcome to allReady

This repo contains the code for allReady, an open-source solution focused on increasing awareness, efficiency and impact of preparedness campaigns as they are delivered by humanitarian and disaster response organizations in local communities.

• Upcoming v1.0 Release
• Project overview
• How you can help

Long-Running and I/O-Bound Operations

If you are interested in working with Azure Functions and moving things like communications, importing data, image processing and more please check out the related repository for our allReady-processing project.

Upcoming v1.0 Release

We are on the path to our first production v1.0 release! We are tracking requirements in our v1.0 Release Milestone and currently directing efforts to closing out issues starting with P1-P3 priority items that are currently being triaged and tagged.

More info to come in our biweekly standups

.NET Core 2.0.x

As part of the work to support cross platform development, we have modified the allReady projects to support .NET Core. This will allow development on Mac devices*. We are currently tracking .NET Core 2.0.x, which we expect to fall into LTS support.

Existing and new developers will need to ensure they have the latest .NET Core SDK supporting the current release 2.0.x. We have added basic steps for developers to setup their device at https://github.com/HTBox/allReady/wiki/Developer-Setup

More detailed setup information for new developers exists at https://github.com/HTBox/allReady/blob/master/docs/prerequisite_install_guide/prerequisite_install_guide.md

Project overview

allReady is focused on increasing awareness, efficiency and impact of preparedness campaigns delivered by humanitarian and disaster response organizations in local communities. As community preparedness and resliency increases, the potential for impactful disasters (both large and small) is greatly decreased. Though not as visible or emotionally salient as saving children from a burning building, preparedness activities like ensuring working smoke detectors in a community, follows the industry rule of thumb where an hour or dollar spent before a disaster is worth 15-30 afterwards. The goal of allReady hinges on growing awareness of, and engaging communities and their volunteers in preparedness campaigns, and more aspirationally, to "put disaster response out of business" by preparing communities to be resilient to inevitable disasters.

To learn more about the need for allReady, the technologies involved and how the app came together, view the project information and blog post on the Humanitarian Toolbox website and watch the In the Code video series:

The allReady project was jumpstarted by volunteers at Microsoft and has been turned over to Humanitarian Toolbox to be maintained and improved by the technical community at large and ultimately deployed in support of organizations delivering preparedness campaigns everywhere.

The initial launch of development for allReady started on 7/20/2015 during the Visual Studio 2015 release event.

How you can help

To help make improvements to this project, you can just clone this repository and start coding, testing, and/or designing.

Important Before jumping in, please review the solution architecture and instructions below to get started. It contains critical information on how to configure the project to run locally and optionally deploy AllReady to Azure.

Also we have a guide on setting up git for open source projects like allReady that can help you get started making contributions. You can find the guide in our docs folder and it also reference a number of blog posts written with additional information on contributing to projects like ours.

Thank you for considering supporting this open source project for humanitarian support.

allready's Issues

Activity Detail page should list description of Tasks, and sort tasks in time / name order

Tasks should be in order and have the description property.

Ideally, also make them have a link to the Task details.

5.1.1.3.3 Introduce Identity Server 4 for identity management

Unit tests: Result of ActivityApiControllerTest.GetAllActivities is unreliable

After fixing #22, ActivityApiControllerTest.GetAllActivities sometimes passes or fails because of a race condition (depending on whether it gets run before or after ActivityApiControllerTest.PostSingleActivity). Since ActivityApiControllerTest.PostSingleActivity adds a record to the database, the count of activity records will not be consistent.

add assigned volunteer to tasks lists

it'd be awesome to show either 1) assigned user or 2) a button that takes you to the assignment page for the activity, if there no assigned user, in the same column.

Responsive image on home page of web app

At the moment the main hero image on the homepage of the web app crops on mobile instead of responsive resizing.

5.1.1.3.7 Organization admins can provide impact updates against the impact target and interim goals

by updating {‘x’ ‘things’ delivered by ‘y’ date} as well as checking off interim goals achieved per 5.1.1.3.4 #35

Meta Issue: Need milestones

Our planning document has a set of aspirations, feature/functional areas and milestone groupings. We need to document those in the milestone section

Automated Tests must be loaded in main solutions

The projects that contain all the automated tests must be loaded and run in the main solution. We need to make it easy for our new volunteers to find and run all the tests

And, we want to encourage all new developers to run those tests.

As an administrator, I want to be able to define actionable items for a given campaign, so people can volunteer for those items

This needs to be fully documented out and split into multiple enhancement issues for what is not yet implemented fully.

This user story covers both the definition of activities and tasks.

Each campaign is split into a set of activities that are tied to a certain geographical location. Each activity, in turn, is split into a set of tasks that the administrator can assign to volunteer that have applied for the activity.

5.1.1.1.4 Allow citizens to click through to links to other websites with related information as provided by organization

[later functionality will include direct ‘request/decline’ interaction]

5.1.1.3.2 Allow organization ‘admins’ to register with username and password on AllReady site as well

5.1.1.2.1 Allow volunteers to act as citizens per 5.1.1.1

References Issue #23

5.1.2.2.2 Allow org admin to view status (accepted, rejected, completed, incomplete) and reassign tasks to new volunteers.

As an organization administrator:

• I am able to view a list of the current task assignment status
• I can navigate from the current task assignment list through to the assignment page

staging database needs to be setup and set for migrations

currently staging runs off of in memory database which is fine for now

5.1.1.2.3 Volunteer contact information is stored along with the skills/resources needed they selected within the system and a link is provided via email to campaign organization owner and recorded in system

As a volunteer, when I offer my help to a campaign:

• My contact details and the skills I select are stored in the system.
• The campaign organizer is notified that there is a new volunteer registered, with a link in the email to view the list of volunteers on the site.

5.1.2.1.2 Allow volunteer to accept/reject task assignment

Requires completed implementation of #40

As a volunteer I can:

• Accept a task assignment
• Reject a task assignment

5.1.1.1.5 Allow citizens to share campaign information via email, txt, twitter and facebook

As an anomyous user, I want to be able to volunteer for an activity, so I can help the overall campaign

Needs to be fully documented and then issues logged for any gaps

update domainurl in service.js of mobile app

For now there is a soon to be - if not already - dead url for domainurl in service.js of the mobile app.

We need to make this configurable/changeable for devs to set to local urls and for us to set as we package the apps for testing and production

5.1.2.1.1 Allow volunteer to see tasks assigned to them

As an authenticated volunteer, I can:

• See the list of tasks assigned to me
• I can navigate to or make use of the task accept/reject feature #41

5.1.1.3.5 Organization admins can list multiple volunteer skills/resources needed

including optional date ranges and locations {‘skill/resource A’ needed [from ‘x’ to ‘y’ date range] [in ‘z’ location scope]}. This listing will allow volunteers to later connect to the organization and offer to volunteer in delivery of the campaign as well as potentially be a data feed consumed by other third party apps that display volunteer needs.

As an user, I can register on the site using my social network accounts

Related to #3 we need to fully document this requirement and decide what bugs/enhancements are needed to fully complete the story in all environments

5.1.1.3.1 Allow organization ‘admins’ to register on the web application with social media/third party logins (twitter, facebook, linkedin, google, microsoft account)

and register with name, email, organization and organization contact info including name, email, phone, website
[later functionality will allow initial admin to grant other users ‘admin’ or other perms for organization]

5.1.2.1.3 Allow volunteer to mark task completed or ‘unable to be completed’ with reason/additional text information

As an administrator, I want to be able to manage a campaign for organizations, so potential volunteers can see it

Will be fleshed out more but looking for full campaign management (CRUD)

This user story covers the following:
•Creating the campaign
•Modifying the campaign
•Deleting the campaign

Build and document strategy for testing with identity providers

as mentioned in the readme the keys for the identify providers will be secrets that are configured in deployment for testing and production.

We need a strategy for how individual contributors can test with identity providers without sharing the 'secret' codes from deployment in production.

Add filtering to most views

Currently there isn't filtering for, say, Activites / Tasks /Campaigns whose end dates are in the past.

Implement past due filtering to fix the bug and additional filters for user functionality.

5.1.1.3.4 Organization admins can create campaigns with landing page content

This feature incorporates a number of tasks:

• Basic model: Name, Description [Rich Text Multi Paragraph with images etc.], Campaign contact info, links to campaign web pages
• #246 simplify Logo/Image upload
• #247 create keyword container/UI (some kind tag library)
• #248 Geography Coverage (zipcode list, city list, state list) be able to select neighborhoods or define a boundary with zip codes or city or state
• #249 Add button to populate contact info from org
• #250 Add thermometer rendering based on current and target values

Previous Copy
including but not limited to: Name, Logo/Image, Description [Rich Text Multi Paragraph with images etc.], Keywords, Geography Coverage (zipcode list, city list, state list), Campaign contact info (allow copy from organization but this may be different per campaign), links to campaign web pages, impact target {‘x’ ‘things’ by ‘y’ date} and list of interim goals in either format of {‘z’ ‘things’ per ‘week/month/quarter’} or {‘z’ ‘things’ by ‘y’ date, ‘z1’ ‘things by ‘y1’ date, …} or {‘textual goal’} the last format of which will not be trackable by the system and will be marked as completed by the admin

5.1.1.1.3 Allow citizens to view campaign details as entered by organization as well as deliver to date vs goals information and targets

e.g. 1500 / 39000 smoke detectors installed & plan to install ~2K per week until end of 2016

Non-hover Link color for logged in, non-admin user is the same color as background

There's a log off and Hello ! link there, but until hovered over they are the same/nearly the same shade as the background.

5.1.2.2.1 Allow org admin to create a task and assign to one or more volunteers

[later functionality to allow variance by volunteer aka these 5 addresses to be completed by 5 volunteers; have multiple volunteers asked and the first to accept gets it; have task matched by skill in system and/or use machine learning to predict best volunteer etc.]

5.1.1.2.4 Allow volunteers to register on the site with social media/third party logins (twitter, facebook, linkedin, google, Microsoft account) to stay connected to the campaign

and with later functionality and/or mobile app be able to receive task assignment ‘missions’ and record delivery data

Meta Issue: Need more issues

During this first week of dev release, there is a backlog of new features and issues (and certainly ones that will come up from the community) that we need to document and log here to support broad contribution by the community.

Replace PrepOps with allReady

During initial dev 'PrepOps' was a codename and it has gotten into just about everywhere from folder names to namespaces to variables etc. This will touch just about everything but we need to move over to 'allReady' going forward.

Filter old activities from Campaign view

By default, the Campaign view should hide activities whose end date is in the past. Optionally, the user should be able to easily view those activities.

Need full user management via Admin for tenant/organization admins

Will need to document more but this functionality needs to be enhanced to have admin add more admin users via oauth and not for tenants

5.1.1.3.6 Organization admins can save campaign info revisions, update them, preview before publishing, publish and publish updates over time

[later functionality (or in V1 if possible) would be to allow citizens to ‘report campaigns as spam/inappropriate’ and then allow admins to take them down and/or ban org admins]

Filter old campaigns from tenant view

By default, hide campaigns whose end date is in the past in the tenant view. Optionally, the user should be able to easily view those campaigns.

Need to enrich Admin username and password handling

At the moment the username and password for the global admin is primarily via config.json.

This needs to be enriched to store it elsewhere securely, have a means to add other admins, change password etc.

5.1.1.4.1 Allow AllReady admins to unpublish campaigns published by organization admins

[later functionality or in V1 if possible would be to ban org admin accounts]

Bombs on activity image upload if no file selected

On the Admin Edit Activity screen, if I load an activity with no image file and click the Upload button, the application throws a null reference exception. It should instead ignore or not allow an image upload with no file selected.

5.1.2.2.3 Communicate to volunteers via email and txt when assignment requests are made with link to website (which ideally provides link to launch/install app) to interact with request

Unit Tests: Improve Unit Test Coverage

The unit test project AllReady.UnitTest only has a 3 tests and only tests the ActivityApiController. Write more tests and improve the robustness of existing tests.

5.1.1.2.2 Allow volunteers to “offer to help” with volunteer needs shown on campaign pages by choosing one or more skills/resources needed and providing contact information to share with organization admin

Name, Email, Phone, Additional Information

Update to work with latest dnx beta6 build

Make this change on the web project as below and fix/update to build and run with the newest build.
[Should now be beta7]

Add styling and proper responsive collapse to navigation menu on global top

The navigation (especially when logged in as user or admin) is unstyled and doesn't responsively collapse as well as it could.

Filter old activities from Activities (multi) view

By default, hide old activities from the Activity/Activities view and allow the user to see them.

5.1.1.1.1 Allow citizens to access the web application anonymously w/o requiring authentication

5.1.1.1.2 Allow citizens to search for campaigns by organization, keyword(s), and geography covered

zipcode for now

Filter old tasks from Activity (single) view

By default, the Activity view should hide tasks whose end date is in the past. Optionally, the user should be able to easily view those tasks.