robbyoconnor / tourmaline-boilerplate

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

Tourmaline Bot Boilerplate

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

Features:

• Internationalization support using TechMagister/i18n
• Background job processing using robacarp/mosquito
• Database support using PostgreSQL, amberframework/micrate, and anykeyh/clear
• Automatic restarts during development using samueleaton/sentry
• Dockerfile for easy deployments

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

• Chris Watson - creator and maintainer