ewea(WIP)

Emergency Early Warning, Early Action Toolkit.

EWEA Context Diagram

Requirements

Installations

WIP

Usage

WIP

Data Model

EWEA 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)

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.

CodeTanzania / ewea

readme