Skip to content

A boilerplate for Telegram bots featuring database integration, internationazation, and background job processing

License

Notifications You must be signed in to change notification settings

protoncr/tourmaline-boilerplate

Repository files navigation

Tourmaline Bot Boilerplate

This is a boilerplate Telegram bot for the Tourmaline Telegram bot framework.

Features:

Usage

  1. Clone the repo and cd into the created directory

    git clone https://github.com/watzon/tourmaline-boilerplate.git
    cd tourmaline-boilerplate
    
  2. Install required shards

    shards install
    
  3. Create and edit envorionment file

    cp .env.example .env
    
  4. Setup and migrate the database (be sure you have configured the DATABASE_URI environment variable)

    ./micrate up
    
  5. Run the bot (using sentry to watch for changes)

    crystal run ./src/sentry.cr
    

Contributing

  1. Fork it (https://github.com/your-github-user/telegram_bot/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

About

A boilerplate for Telegram bots featuring database integration, internationazation, and background job processing

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published