Giter Site home page Giter Site logo

hixon10 / telegram-calendar-notifications Goto Github PK

View Code? Open in Web Editor NEW
2.0 3.0 3.0 714 KB

Telegram calendar notifications

Home Page: https://telegram.me/calendar_notifications_bot

License: Apache License 2.0

Kotlin 87.81% Java 10.69% Shell 1.50%
kotlin micronaut telegram-bot calendar-notifications ics graal-native mongodb

telegram-calendar-notifications's Introduction

Telegram calendar notifications

This project contains source codes for telegram bot: https://telegram.me/calendar_notifications_bot

Main purpose of this bot is notification about your calendar event, using telegram for notification target.

You need to set up one or more calendar in ics-format.

Adding calendar to the bot

You need to send ics URL and before notification minutes to the bot.

In this example we want to get notifications for calendar https://example.ru/3242352/file.ics, before 15 minutes for event.

https://example.ru/3242352/file.ics 15

Bot commands:

  1. stop - Stop sending notifications
  2. about - Get github link to the bot repository
  3. calendars - Send subscribed calendars
  4. help - Info, how to use the bot
  5. events - Send my events

Run bot:

  1. We have pre-build docker images with this bot: https://github.com/users/Hixon10/packages/container/package/telegram-calendar-notifications%2Ftelegram-calendar-notifications
  2. Most straightforward way how to run it is configure of settings in env.list ( https://github.com/Hixon10/telegram-calendar-notifications/blob/master/env.list ) and run run.sh ( https://github.com/Hixon10/telegram-calendar-notifications/blob/master/run.sh )

Build:

  1. Set telegram token via TELEGRAM_TOKEN environment variable
  2. Set MongoDB url via MONGODB_URI environment variable (note! you can use only mongodb:// protocol, because of GraalVM Native image)
  3. Create a GraalVM Native image via ./gradlew dockerBuildNative

Run Unit tests:

  1. ./gradle clean test

Run Integration tests:

  1. Set telegram token via TELEGRAM_TOKEN environment variable
  2. Set MongoDB url via MONGODB_URI environment variable (note! you can use only mongodb:// protocol, because of GraalVM Native image)
  3. ./gradle clean integrationTest

telegram-calendar-notifications's People

Contributors

hixon10 avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.