Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/codetanzania/ewea

Emergency Early Warning, Early Action Toolkit(WIP).
https://github.com/codetanzania/ewea

alert codetanzania disaster emergency emis event ewea hazard incident risk warning

Last synced: about 4 hours ago
JSON representation

Emergency Early Warning, Early Action Toolkit(WIP).

Host: GitHub
URL: https://github.com/codetanzania/ewea
Owner: CodeTanzania
License: mit
Created: 2019-09-23T12:22:22.000Z (about 5 years ago)
Default Branch: develop
Last Pushed: 2021-06-05T22:17:45.000Z (over 3 years ago)
Last Synced: 2024-04-14T10:06:09.935Z (7 months ago)
Topics: alert, codetanzania, disaster, emergency, emis, event, ewea, hazard, incident, risk, warning
Language: JavaScript
Homepage:
Size: 8.56 MB
Stars: 12
Watchers: 4
Forks: 4
Open Issues: 47
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

        # ewea(WIP)

[![Build Status](https://travis-ci.org/CodeTanzania/ewea.svg?branch=develop)](https://travis-ci.org/CodeTanzania/ewea)

[![Dependencies Status](https://david-dm.org/CodeTanzania/ewea.svg)](https://david-dm.org/CodeTanzania/ewea)

[![Coverage Status](https://coveralls.io/repos/github/CodeTanzania/ewea/badge.svg?branch=develop)](https://coveralls.io/github/CodeTanzania/ewea?branch=develop)

[![GitHub License](https://img.shields.io/github/license/CodeTanzania/ewea)](https://github.com/CodeTanzania/ewea/blob/develop/LICENSE)

[![Renovate Enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)

[![Commitizen Friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![Code Style](https://badgen.net/badge/code%20style/airbnb/ff5a5f?icon=airbnb)](https://github.com/airbnb/javascript)

Emergency Early Warning, Early Action Toolkit.

![EWEA Context Diagram](./docs/context.png)

## Requirements

- [NodeJS v14.1+](https://nodejs.org)

- [MongoDB v4+](https://www.mongodb.com/)

- [Redis v5+](https://redis.io/)

## Installations

> WIP

## Usage

> WIP

## Data Model

![EWEA Data Model](./docs/domain.png)

## Develop

- Clone this repository

```sh

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

```

- Install dependencies

```sh

$ npm install

```

- Copy environment variables

```sh

$ cp .env.example .env

```

- Seed development data

```sh

$ npm run scripts:seed

```

- Run development server

```sh

$ npm run start:dev

```

- Run test

```sh

$ npm test

```

> To run heroku tasks ensure your have installed [heroku cli](https://devcenter.heroku.com/articles/heroku-cli#download-and-install)

## 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

```sh

$ 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.