shibot
Track a ship and send telegram messages
GPL-2.0 License
shibot
Track a ship with a simple Telegram interface. This consists of two node scripts, one that tracks a ship, another one running a very simple Telegram bot that answers to the command \donde, where is the ship.
Installation
Not available, for the time being, from any module repository. So you will need to clone this
# GitHub official CLI
gh repo clone JJ/shibot
# vanilla git
git clone [email protected]:JJ/shibot.git
Then
cd shibot
npm ci
To install required dependencies. This will help you develop, but keep on reading for actually running it.
Running the scripts
We are using 3 APIs here, you'll have to obtain keys for all of them
Save them in a .env file (remember, never add this to your repo, even if it's private; it's in the .gitignore file, so unless you do it on purpose, you're safe):
BRBSTR_TOKEN=<Telegram bot token issued by The BotFather>
GEOAPIFY_API_KEY=<GeoAPIfy API key>
AISSTREAM_API_KEY=<AISStream API key>
Check dot.env as an example.
More info
Check out the presentation at Tech, Talk & Tapas 2023
See also
aisstreamer is a node.js library
that spins off the tracking part of this application. Check it out.
LICENSE
(c) JJ Merelo, 2023
Released under the GPL v3.0 license.