https://github.com/k-yle/akl-ferry-capacity
https://github.com/k-yle/akl-ferry-capacity
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/k-yle/akl-ferry-capacity
- Owner: k-yle
- Created: 2023-04-25T09:29:51.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-05T05:23:45.000Z (over 1 year ago)
- Last Synced: 2025-03-05T06:26:42.418Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://akl.boats
- Size: 715 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ferry Capacities
This app shows you which ferry is currently operating each route in Auckland, and how many passengers and bikes it can take.
It's quite common that the smaller ferries leave people behind because of their limited capacity. This App helps you judge whether to take the ferry or not.
# How it works
All this information is free and publicly available, but it's unfortunately not integrated into the official AT mobile app.
```mermaid
flowchart TD
VesselPositions["Vessel Positions"] -->|via AIS| AT
Cancellations --> AT
VesselDetails["Vessel Capacities"] -->|via Wikipedia| Wikidata
VesselPhotos["Vessel Photos"] -->|via Wikimedia Commons| Wikidata
Wikidata -->|via Sparql query| ThisApp[fa:fa-ship This App]
AT -->|via AT API| ThisApp
Timetables --> AT_GTFS[AT GTFS]
AT_GTFS -->|via .zip file| ThisApp
Logos["Company Logos"] -->|via Facebook| Wikidata
```
Our server consolidates this data into [a single API](https://akl.boats/api/vessel_positions) which the app can use.
# Contributing to the code
If you just want to edit data about vessels, you can do that from [the Wikipedia page](https://en.wikipedia.org/wiki/List_of_Auckland_ferries).
To contribute to the code:
- install NodeJS v18+
- Install Visual Studio Code
- `cd` into the reposity
- run `npm install`
- run `npm run start` to start the server on http://localhost:8788
- open http://localhost:8788 in your web browser