SIREN: Service for Immediate Relay of Emergency Notification

SIREN is a powerful, automated service designed to listen for and track National Weather Service (NWS) alerts in real-time. It provides a web interface and push service for relay of these alerts.

Table of Contents

1. System Design
   • Architecture Diagram
   • Sequence Diagram
2. Getting Started
   • Prerequisites
   • Installation
   • Running the Project
3. Created By

System Design

Architecture Diagram

Sequence Diagram

Getting Started

Prerequisites

The following needs to be installed on your system:

• Git
• Docker Desktop
• Go (Golang) (Latest Stable)
• Node.js LTS (v22)
• Visual Studio Code (VSCode)

Additionally:

• Make sure you are properly logged into GitHub from the git cli
• Make sure you can run go version and node --version
• Start Docker Desktop before trying to run docker commands

Installation

1. Clone the Repo

git clone https://github.com/CS4366/SIREN.git
cd SIREN

2. Install Dependencies

• Go Dependencies:

  cd services/noaa-service
  go mod tidy
  cd ../tracking-service
  go mod tidy

• Node Dependencies:

  cd ../frontend-service
  npm install
  cd ../api-service
  npm install
  cd ../push-service
  npm install

Running the Project

Step 1: Start Docker Compose

In the root directory, start the Docker containers:

docker compose up -d

Step 2: Launch Services in VSCode

1. Open the root directory in VSCode:

   code .

2. Use the preconfigured launch configurations to start the services in this order:

   1. Launch NOAA Service
   2. Launch Tracking Service
   3. Launch API Service
   4. Launch Push Service
   5. Launch Frontend

Alternatively, you can run the compound configuration:

• Launch All Services

Optional: Running Manually

If needed, the services can be started manually:

1. NOAA Service

   cd services/noaa-service
   go run main.go

2. Tracking Service

   cd services/tracking-service
   go run main.go

3. API Service

   cd services/api-service
   npm run dev

4. Push Service

   cd services/push-service
   npm run dev

5. Frontend

   cd services/frontend-service
   npm run dev

Created By

Zoie Bonnette	Jacob Bruen	Jackson Casey	Patrick Fontaine	Barry Gorman