codetanzania/ewea

Emergency Early Warning, Early Action Toolkit(WIP).

ewea(WIP)

Emergency Early Warning, Early Action Toolkit.

Requirements

• NodeJS v14.1+
• MongoDB v4+
• Redis v5+

Installations

WIP

Usage

WIP

Data Model

Develop

• Clone this repository

$ git clone https://github.com/CodeTanzania/ewea.git

• Install dependencies

$ npm install

• Copy environment variables

$ cp .env.example .env

• Seed development data

$ npm run scripts:seed

• Run development server

$ npm run start:dev

• Run test

$ npm test

To run heroku tasks ensure your have installed heroku cli

Document

It will be nice, to keep documentation under docs folder up to date when changes applied. We opted markdown for all documentations.

• Run development documentation server

$ npm run docs:dev

• Then apply your changes on affected sections.

Contribute

It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.

License

The MIT License (MIT)

Copyright (c) CodeTanzania & Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

ewea's Issues

As a responder, I want reply on event action taken via email link

As a user, I want resent event changelog notification if not sent out

Tasks

• POST changelogs/:id/notifications

Support event group and multiple administrative areas on event action catalogue

As a user I want to manage emergency(event) certainty so that I can classify warning(alerts) as they reported and disseminated

As an agency, I want approve resource request

As a responder, I want provide list of victims so that they can be added to event damages and losses report(assessment)

name: String,
identity: String,
photo: Image,
mobile: String,
email: String,
address: String

As a user, I want organize(or breakdown) event type with hierarchies so that I can generate aggregated reports

As a user I want to manage emergency(event) functions so that can be assigned to respective primary and secondary stakeholders

As a user I want to manage focal people so that I can assign emergency(event) actions to them

As a responder, I want provide demage report so that it can be associated with event damage report

As a responder, I want reply on event effect via special keyword(or code)

As a user I want to manage administrative boundaries so that I can assign emergency(event) actions to stakeholder base on their locality

As a user I want to manage emergency(event) severity so that I can classify warning(alerts) as they reported and disseminated

As a responder, I want reply on event need via special keyword(or code)

As an emergency coordinator, I want request action(s) to be taken from a given event

Tasks

Web UI

• Provide a Request for Action on event list
• Provide request Request for Action on selected event
• Provide a means to select specific function, action, roles and groups before request for action
• Provide ability to request for all actions

API

• Provide and impove disseminations endpoint for Request for Action

As a user I want to manage emergency(event) types so that I can classify warning(alerts) as they reported and disseminated

As a user, I want add source to all sent notifications so that they can used for further followups

Tasks

• Allow adding source name, email, link etc

As a coordinator, I want to disseminate action catalogue so that responders can be aware of their actions

As a coordinator, I want request needs from responder so that I can compile emergency event needs assessment report

As a coordinator, I want images to be sent on all notifications so that they can aid on visualizing the event situation

Tasks

• Show images on email
• Add links to image source

As a coordinator, I want request resources from an agency

As a user I want to manage emergency(event) status so that I can classify warning(alerts) as they reported and disseminated

As a responder, I want reply on event action taken via special keyword(or code)

Misc immediate issues

Shortcuts needed

• Location(s)
• Agencies
• Focals
• Actions Taken
• Impacts
• Needs
• Administrative Hierarchy

Missing properties(event)

• Group
• Populate roles and groups on action catalogue

Administrative areas

• Show level of an area

Question

• Topic

Missing actions

• set new updatedAt on event when changelog has been updated
• Add changelog creator/ initiator
• Disseminate per role per group per agency

Issues

• Update event error has issues when deleting existing area
• Add Role for changelog initiator

As a responder, I want reply on event effect via email link

As an API client I want to consume data as GeoJSON so that I can provide map visualizations

As a coordinator, I want request effect from a responder so that I can compile emergency event effects assessment report

As a user, I want to define administrative hierarchy(administrative levels) so that they can be added to all events

Tasks

• Allow administrative hierarchy configuration/setting
• Support hierarchy on the event

Motivation

{
 hierarchy: {
  regions: [...],
  districts: [...],
  wards: [...]
 }
}

As a user I want to manage agencies so that I can know responsible focal people from them as well as assign emergency(event) functions to them

As an API client I want to consume data as topojson so that I can provide map visualizations

Tools:

• https://github.com/mbostock/shapefile
• https://github.com/topojson/world-atlas
• https://github.com/topojson/topojson

As a user I want to visualize action taken per issues alert(event) so that I can know who did and who did not perform the action

As a user, I want define message templates so that they can be used on sending notification based on party particulars

type: EventType,
group: PartyGroud,
role: PartyRole
template: Lingual{en, sw, ...}

Archiving data doesn't seems to work now

As a coordinator, I want close an event so that i can mark its end

Tasks

• Set endedAt when end event via changelog API
• Notify stakeholder on end of event
• Remind coordinator on ending event

Exception

• Is event re-open allowed?

As a user I want to manage emergency(event) urgency so that I can classify warning(alerts) as they reported and disseminated

As a responder, I want reply on event need via email link

Iteration Plan Nov 2019 - March 2020

This is a proposed iteration plan for finalizing EWEA(Early Warning and Early Action) tool

Simple Legend annotations

Symbol	Meaning
🔴	Blocked Task
🤔	Under Discussion
👍	Ready for Implementation
🏃‍♂️	In Progress

🚧 TODO

👷‍♂️ 👷‍♀️ General

• 🤔 Think about user management @lykmapipo
• 🤔 Discussion about survey for collecting preparedness actions(activities) @lykmapipo

UI

• 👍 Improve mobile experience for dashboards @navish
• 👍 Add action to unblock user/ Party in UI @BenMaruchu
• 👍 Add Multilingual support @BenMaruchu
• 👍 Review all UIs @navish

⚠️ Issuing Alerts (API)

• 👍 Wiring issuing alert with action catalog @lykmapipo
• 👍 Disseminating alert via multiple channels(SMS, BOT, EMAIL,PUSH) @lykmapipo

📝 Documentation

🖥️ Dashboard and visualizations

• 👍 Visualize issued alerts @lykmapipo
• 👍 Visualize collected feedback @lykmapipo

💬 Feedback per Alert

• 👍 Create Facebook bot @lykmapipo
• 🤔 If necessary create telegram bot @lykmapipo
• 🤔 Discuss and design action feedback @lykmapipo

✔️ 💪 DONE

• Improve mobile experience for lists @navish
• Improve mobile experience for lists @navish
• Review social network to support i.e Facebook, Telegram and Whatsapp @lykmapipo
• Add action catalog endpoint @BenMaruchu , @rijkerd
• Mount notification endpoint @lykmapipo
• Add action catalog endpoint @BenMaruchu , @rijkerd
• Add area in event form @BenMaruchu
• Deploy EWEA API for dev @lykmapipo
• Add seed data for indicator @lykmapipo
• Add seed data for questions @lykmapipo
• Add event catalog seed @lykmapipo
• Add notification template UI @rijkerd
• Add settings icons @navish
• Add UI for Indicators @mkumbobeaty
• Add UI for Event Questions @mkumbobeaty
• Add documentation for event question @rijkerd
• Add UI for features @mkumbobeaty
• Add UI for Event actions @BenMaruchu
• Add settings menu @BenMaruchu
• Add UI for event type @mkumbobeaty
• Prepare seed data for action catalog @navish, @BenMaruchu, @mkumbobeaty
• Add event action @navish
• Add documentation for feature type @rijkerd
• Add documentation for event indicator @rijkerd
• Add documentation for unit @rijkerd
• 🏃‍♂️ Create postman collection for all endpoints @BenMaruchu, @rijkerd
• Update documentation for feature type @BenMaruchu
• Add notification template @lykmapipo, @rijkerd
• Finalize shape files needed @lykmapipo
• Add feature endpoint(seed data) @lykmapipo
• Migrate alert to event API @BenMaruchu
• Document authentication @rijkerd
• Add event changelog(feed) endpoint @lykmapipo
• Add documentation for Parties (Stakeholders) @BenMaruchu
• Add Administrative Boundaries endpoint @lykmapipo
• Migrate Roles to use new EWEA API @BenMaruchu
• Add Administrative Level endpoint @mkumbobeaty
• Add UI for event certainty @Mloweedgar
• Add Party Group UI @Mloweedgar
• Add UI for administrative Areas @Mloweedgar
• Add UI for Event Group @Mloweedgar
• Add Event Topic UI @Mloweedgar
• Add UI for event severity @Mloweedgar
• Add UI for event function @Mloweedgar
• Add Unit of Measure UI @Mloweedgar
• Add map preview for critical feature @Mloweedgar
• Add feature documentation @Mloweedgar
• Update documentation for event function @Mloweedgar
• Add documentation for party roles @Mloweedgar
• Add event severity #12 @Mloweedgar
• Add event certainty #13 @Mloweedgar
• Add documentation for party groups @Mloweedgar
• Add event group @BenMaruchu
• Add event type @BenMaruchu
• Add event function / emergency functions @navish
• Add feature type endpoint @lykmapipo

As a user, I want to notify all lowest administrative areas when I report or update an event

Tasks

• Find all lowest administrative areas from the current administrative area
• Include them on notification criteria
• Support simple flags on event to always notify everyone in case is needed
• Support notifyAll on EventType

As a respondent, I want request resources from an agency

As a coordinator, I want sent generic instruction to responder(s) so that they can perform required actions

As a user, I want to request for an action to be performed

As a coordinator, I want disseminate event and its action to responders so that they can take actions

As a user I want to issue a warning(alert) so that it can be disseminated to respective stakeholders to take actions

As a user I want to manage emergency(event) - action matrix(catalog) so that I can disseminate respective action to each stakeholder and obtain feedback

As a user, I want report(or record) event cases(or report) so that I can update an event

As a responder, I want provide loss report so that it can be associated with event loss report

As a user, I want set event start time so that its current active duration can be calculated

Tasks

• Set startedAt or onset from user, default to createdAt
• Calculate event duration in milliseconds endedAt - startedAt