FireYak

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 8 Open GitHub ↗

Quickly find the nearest fire hydrant

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# FireYak

FireYak helps fire departments quickly find the nearest usable water source (e.g. fire hydrants, suction points, water tanks, fire water ponds, fire stations) based on **OpenStreetMap** data.

All water source data comes from the community-driven project [OpenStreetMap](https://www.openstreetmap.org).
If a hydrant or water source is missing or incorrect, you can add, edit or delete it directly within the app — no need to leave FireYak.

---

## Download

**Web:** [app.fireyak.org](https://app.fireyak.org)
The web app is a Progressive Web App (PWA) and can be installed to the home screen on most modern browsers.

---

## Features

### Interactive map of water sources

- Displays nearby water sources using OpenStreetMap data:
  - `emergency=fire_hydrant`
  - `emergency=water_tank`
  - `emergency=suction_point`
  - `emergency=fire_water_pond`
  - `amenity=fire_station`
- Different icons for hydrants, suction points, water tanks, ponds and fire stations.
- Map view and last position are restored on reopen.
- Dark mode support.

### Detailed marker information

When you tap/click a marker, FireYak shows:

- Hydrant / water source type (pillar, underground, wall, pond, etc.)
- Pipe diameter, pressure, flow capacity / flow rate
- Couplings (type, diameters)
- Water source type (main, pond, stream, river, lake, tank, well, etc.)
- Capacity/volume where tagged
- Reference number, operator, name and address (if available)
- Access, notes, survey date, coordinates and OSM ID

You can:

- Open the object directly on **openstreetmap.org**.
- Open the object in the **OSM editor** to improve the data.
- Start navigation to the location (mobile & desktop).
- Share a link to the marker.

### Add, edit & delete water sources

You can manage water sources directly within the app — all changes are synced to OpenStreetMap in real time.

**Add a new marker:**
- Press the + button at the bottom right.
- Choose the type: fire hydrant, suction point or water tank.
- Fill in details (diameter, pressure, flow, couplings, operator, etc.) and save.

**Edit an existing marker:**
- Tap a marker, then tap the edit button in the info panel.
- Update any field — leave a field empty to remove it from OpenStreetMap.

**Delete a marker:**
- Open the edit panel for a marker and tap the trash icon.
- A confirmation dialog ensures nothing is deleted by accident.

All operations require an OpenStreetMap account (OAuth2 login is built in).
Changes are uploaded immediately and include a changeset comment referencing FireYak.

### Photos

FireYak shows photos of the selected marker in a full-screen gallery, collected from:

- **Wikimedia Commons** — files named after the pattern `Fire-fighting-facility node-<OSM_ID>`
- **Panoramax** — the picture referenced by the marker's `panoramax` tag

Each photo is labelled with its source and links back to the original.

### Nearby water sources

- Use your current location to list the **nearest water sources** (e.g. nearest hydrants).
- Distance display in meters/kilometres.
- Rough estimation of the required number of B-hoses based on configured hose length.
- Quick selection of a nearby source to see full details.

### Supply pipe / relay pump calculation

FireYak includes a **relay pump / supply pipe calculator**:

- Set:
  - **Fire object** (target point)
  - **Suction point** (water source)
  - Optional **waypoints** (route via streets, terrain, etc.)
- Uses elevation data to estimate:
  - Real (3D) hose distance along the route
  - Elevation difference between suction and fire object
- Calculates:
  - Approximate number of B-hoses required
  - Number and positions of intermediate pumps
  - For each pump and for the fire object:
    - Distance from suction point
    - Elevation gain
    - Pressure at the pump / inlet

Configuration:

- Adjustable:
  - Output pressure
  - Minimum input pressure
  - Pressure loss per meter (depending on flow rate)

### Localization

- English
- German

---

## For developers

| Layer | Technology |
|---|---|
| Frontend | Vue 3 + Ionic Vue |
| Language | TypeScript |
| State | Pinia |
| Routing | Vue Router |
| Maps | Leaflet + marker clustering |
| Local storage | IndexedDB (via `idb`) |
| PWA | Vite + `vite-plugin-pwa` |
| Mobile | Capacitor (iOS + Android) |
| OSM editing | osm-api (OAuth2 PKCE) |
| Elevation | Open-Meteo API |
| Image gallery | PhotoSwipe (Wikimedia Commons, Panoramax) |
| CI/CD | GitHub Actions + Fastlane |

## Development

### Setup

```bash
npm install
```

### Run in development

```bash
npm run dev
```

Then open the printed URL (typically http://localhost:5173) in your browser.

### Build

```bash
# web only
npm run build

# web + sync native platforms
npm run buildAndSync
```

### Lint

```bash
npm run lint
```

The Android project lives in the `android/` directory and can be built with Gradle / Android Studio.
The iOS project lives in the `ios/` directory and can be built with Xcode.

---

## Support

If you find FireYak useful, please consider supporting it:

You can also:

- Star the project on GitHub
- Report issues and improvement ideas
- Contribute code or documentation

FireYak

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README