https://github.com/mihai3/osmcal-matrix-bot

A Matrix bot for posting osmcal.org event reminders to a Matrix channel
https://github.com/mihai3/osmcal-matrix-bot

matrix-org openstreetmap osmcal

Last synced: about 19 hours ago
JSON representation

A Matrix bot for posting osmcal.org event reminders to a Matrix channel

• Host: GitHub
• URL: https://github.com/mihai3/osmcal-matrix-bot
• Owner: mihai3
• License: other
• Created: 2025-02-08T19:12:57.000Z (1 day ago)
• Default Branch: main
• Last Pushed: 2025-02-08T21:05:38.000Z (1 day ago)
• Last Synced: 2025-02-08T22:19:26.900Z (1 day ago)
• Topics: matrix-org, openstreetmap, osmcal
• Language: TypeScript
• Homepage:
• Size: 93.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# osmcal-matrix-bot

https://github.com/mihai3/osmcal-matrix-bot.git

A Matrix bot for posting osmcal.org reminders to a Matrix channel.

You can configure which channels should receive reminders for which locations and in which language.

## Running / Building

* Edit `config/production.yaml`, see `config/default.yaml`

* Make sure you have Node.js 20+ installed

* run `./osmcal-matrix-bot`

Or with Docker: `docker build -t osmcal-matrix-bot:latest .`

To run the Docker image (after building): `docker run --rm -it -v $(pwd)/config:/bot/config -v $(pwd)/storage:/bot/storage osmcal-matrix-bot:latest`

## Project highlights

### `src/index.ts`

This is where most of the bot is.

### `src/login.ts`

A helper command line script for logging in the bot and getting an access token.

## Credits

Based on the [matrix-bot-sdk-bot-template](https://github.com/turt2live/matrix-bot-sdk-bot-template), originally licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0), for creating bots with [matrix-bot-sdk](https://www.npmjs.com/package/matrix-bot-sdk).