https://github.com/waffensultan/ph-emergency-hotlines-api
https://github.com/waffensultan/ph-emergency-hotlines-api
api expressjs typescript
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/waffensultan/ph-emergency-hotlines-api
- Owner: waffensultan
- Created: 2024-10-25T02:24:45.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-12-19T06:14:05.000Z (5 months ago)
- Last Synced: 2024-12-19T07:19:51.533Z (5 months ago)
- Topics: api, expressjs, typescript
- Language: TypeScript
- Homepage:
- Size: 69.3 KB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Welcome to [Philippines Emergency Hotlines API](https://github.com/waffensultan/philipppines-emergency-hotlines-api)!
Easily retrieve critical emergency hotlines information in the Philippines with just one API call.
# Table of Contents
- [Usage](#usage)
- [Getting Started](#getting-started)
- [Contributing](#contributing)
## Usage
* #### API Call Structure
```bash
https://ph-emergency-hotlines-api.onrender.com/api/{region}/{province}/{city_or_municipality}?hotline={hotline_type}
```
* #### Example (JavaScript):
```javascript
try {
const response = await fetch('https://ph-emergency-hotlines-api.onrender.com/api/calabarzon/cavite/alfonso?hotline=police')
const data = await response.json();
// Your code on handling data...
} catch (error) {
// Your error handling process here...
}
```
For better clarification, you can check out the demo here: https://ph-emergency-hotlines-frontend.vercel.app/
## Getting Started
1. Clone the project:
```bash
git clone https://github.com/waffensultan/ph-emergency-hotlines-api.git
```
2. Install the project dependencies:
```bash
npm install
```
3. Run the server:
```bash
npm run dev
```
Your server will now be running locally in your machine!
## Contributing
Contributions are welcomed and appreciated.
- [Adding new fields](#adding-new-fields)
- [Generating new source files](#generating-new-source-files)
---
- ### Adding new fields
```
region: {
province: {
city_municipality: {
hotline_type: [
{
"abbreviation"?: string,
"name": string,
"hotlines": [
{
"number": string,
"range"?: string,
"location_code"?: string;
}
]
}
]
}
}
}
```
The JSON structure above describes the complete format for the central `source.json` file, located in `models/data/source.json`.
Available hotline types (hotline_type) are:
- general
- police
- medical
- rescue_disaster
- earthquake_seismic
- traffic
- social
- digital
You can also add more as you see fit! Feel free to make contributions or PRs by adding new data to the central `source.json` and ending with the step below :)
---
- ### Generating new source files
After creating new fields, run the following command in your preferred CLI:
```bash
npm run generate-source-files
```
What it does is run `scripts/generate-source-files.ts` which automates the process of creating separate `source.json` files for each level (regional, provincial, and city/municipal).
For scalability, separating data into individual `source.json` files is significantly more efficient than relying on a single `source.json` file. This approach greatly reduces GET request response times, resulting in faster data retrieval, previously taking 100+ ms now down to 10-90 ms.