https://github.com/encryptex/firestation-alerts
The definitive platform to handle and montior all incoming firestation alerts.
https://github.com/encryptex/firestation-alerts
Last synced: 7 months ago
JSON representation
The definitive platform to handle and montior all incoming firestation alerts.
- Host: GitHub
- URL: https://github.com/encryptex/firestation-alerts
- Owner: EncryptEx
- Created: 2022-08-29T20:37:42.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-14T19:45:02.000Z (over 1 year ago)
- Last Synced: 2025-01-13T03:45:38.628Z (about 1 year ago)
- Language: PHP
- Homepage:
- Size: 337 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Firestation Alerts
The definitive platform to handle and montior all incoming firestation alerts.
A platform part of a [Research Project](##Research%20Project) (TR of 2nd Batxillerat in Catalunya). The functionality is pretty simple to understand: When endpoint `/api/newNotification.php` is requested with correct credentials and passing the [necessary parameters](##Api%20Parameters), it will pop up an alert to all connected clients whithin the country affected. In case that the coordinates point to international waters, the alert will pop up in all clients with no restriction at all.
---
## Architecture
This project is using
- PHP
- MySQL (pdo conections)
- Composer, to use:
- vlucas/**phpdotenv** (credentials management)
- phpmailer/**phpmailer** (SMTP email library)
- cboden/**ratchet** (WebSocket PHP library)
- Bootstrap 5
- Material Symbols and Icons
- FREE APIs used:
- Maps API: [Open Street Map](https://wiki.openstreetmap.org/) and [Leaftlet](https://wiki.openstreetmap.org/wiki/Leaflet)
- Street info trough Geocoords, ([Geocode.maps.co](https://geocode.maps.co/))
---
## Demo
This is only a little part of the final practical part of the research project. For more information, I strongly recommend to check out the entire research paper: [PDF link](##Research%20Project)
---
## Installation
The installation process will be described in the PDF of the [Research Project](##Research%20Project)
---
## Research Project
Link to Research Paper can be found [here](https://jaumelopez.dev/projects.php)
---
### Suggestions or questions
If you feel that something is wrong in this README file or you need help while setting up this project, feel free to contact or open a [GitHub Issue](https://github.com/EncryptEx/firestation-alerts/issues/new).
---
