8000 GitHub - open-ews/open-ews: The world's first Open Source Emergency Warning System Dissemination Platform
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

open-ews/open-ews

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

DPG Badge Build codecov View performance data on Skylight

The world's first Open Source Emergency Warning System Dissemination Platform.

somleng-ews-dissemination-dashboard-drawing

The EWS4All initiative calls for:

Every person on Earth to be protected by early warning systems within by 2027.

We're helping to achieve this goal by building and certifying OpenEWS - the world's first Open Source Emergency Warning System Dissemination Platform.

πŸ›οΈ OpenEWS is intended to be used by alerting authorities to disseminate warning messages to beneficiaries in case of a natural disaster or other public emergency. It's actively being used by the following alerting authorities:

πŸ‡°πŸ‡­ Cambodia

National Committee for Disaster Management (NCDM) NCDM is the central agency responsible for disaster risk management in Cambodia. It uses OpenEWS to disseminate alerts across the country via SMS and other channels.

πŸ‡±πŸ‡¦ Laos

Department of Meteorology and Hydrology (DMH) DMH is the national authority for weather forecasting and hydrological monitoring in Laos. It uses OpenEWS to issue timely warnings about severe weather events to at-risk communities.

🌟 Features

  • πŸ‘―β€β™€οΈ Aesthetically Beautiful OpenEWS is designed with a modern and intuitive user interface that’s clean, accessible, and easy on the eyes, helping users focus on what matters: saving lives.

  • 🧘 Easy to Use Whether you're a disaster management official or a local responder, OpenEWS is built to be straightforward and user-friendly, with minimal training required.

  • πŸ—£οΈ Localizable OpenEWS supports localization, allowing the platform to be fully translated and adapted to any language, including right-to-left and non-Latin scripts like Khmer and Lao.

  • πŸ›œ Interoperable OpenEWS integrates easily with mobile network operators, government databases, and early warning protocols. It is designed to be API-driven and works across diverse communication channels including SMS, IVR, and Cell Broadcast.

  • πŸ’– Free and Open Source Built under the permissive MIT License, OpenEWS is fully open-source. Anyone can inspect, use, and contribute to the codebase, no vendor lock-in, no hidden costs.

  • βœ… DPG Certified OpenEWS meets the Digital Public Goods Standard and is certified as a Digital Public Good. This ensures the platform adheres to key principles like privacy, openness, and do-no-harm.

πŸ“‘ Message Delivery via Somleng

OpenEWS integrates seamlessly with Somleng right out of the box to deliver emergency warning messages to beneficiaries.

Somleng is an open-source, DPG Certified Telc 8000 o-as-a-Service (TaaS) and Communications Platform-as-a-Service (CPaaS). It enables low-cost, scalable communication infrastructureβ€”especially in low-resource settings.

Local Mobile Network Operators (MNOs) can use Somleng to distribute Early Warning System (EWS) alerts across the following channels:

  • πŸ“² Voice Alerts (IVR) – Interactive voice calls to inform and instruct.
  • πŸ’¬ SMS – Text-based warnings in local languages.
  • πŸ—Ό Cell Broadcast – Area-based alerts sent to all phones in a coverage zone.

πŸš€ Getting Started (Local Development with Docker)

This guide will help you get OpenEWS running locally using Docker. It is the fastest way to get started for development and testing purposes.

Prerequisites

Before you begin, ensure you have the following installed on your system:

1. Clone the Repository

git clone https://github.com/open-ews/open-ews.git
cd open-ews

2. Build and Start the Services

Run the following command to build and start the application:

docker-compose up --build

This will:

  • Build the Docker containers
  • Start the web app and PostgreSQL

3. Seed the database

Run the following command to seed the database:

docker compose exec open-ews bundle exec rails db:setup

This will:

  • Create the database
  • Seed the database with sample data

After the command runs, it will output:

  • The user credentials for logging into the web interface
  • The API key for authenticating with the API

πŸ“Œ Be sure to copy and store this information somewhere safe during development.

4. Access the Application

Once the services are up, open your browser and navigate to:

http://my-alerting-authority.app.lvh.me:3000

You should see the OpenEWS application running and you can login with the credentials from the output above.

5. Testing the API with cURL

You can interact with the OpenEWS API using your generated API key. Here's how to create a beneficiary using cURL.

curl -X POST http://api.lvh.me:3000/v1/beneficiaries \
  -H "Authorization: Bearer YOUR_API_KEY_HERE" \
  -H "Content-Type: application/vnd.api+json" \
  -d '{
    "data": {
      "type": "beneficiary",
      "attributes": {
        "phone_number": "+85510999999",
        "iso_country_code": "KH"
      }
    }
  }'

Replace YOUR_API_KEY_HERE with the actual key that was displayed when running rails db:setup.

If successful, the API will respond with the details of the newly created beneficiary in JSON format.

πŸ“– You can find more API endpoints and usage examples in the upcoming OpenEWS API documentation.

πŸ”„ Common Commands

  • Rebuild containers:

    docker-compose up --build
  • Stop the application:

    docker-compose down

πŸ“š Additional Resources


If you run into any issues, feel free to open an issue or start a discussion in the GitHub Issues tab.

Deployment

The infrastructure directory contains Terraform configuration files in order to deploy OpenEWS to AWS.

The infrastructure in this repository depends on some shared core infrastructure. This core infrastructure can be found in The Somleng Project repository.

License

The software is available as open source under the terms of the MIT License.

About

The world's first Open Source Emergency Warning System Dissemination Platform

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 
0