tourmaline_boilerplate

master branch1 version
  • master branchlatestJun 10, 2020

github.com/protoncr/tourmaline-boilerplate

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

3 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  tourmaline_boilerplate:
    github: protoncr/tourmaline-boilerplate
    branch: master

master is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal
0.34.0
License
MIT
Author
Chris Watson
Target
  • bot from src/bot.cr

Dependencies

Runtime Dependencies

  • pg*github: will/crystal-pg, branch: master
  • i18n*github: TechMagister/i18n.cr, branch: master
  • clear*github: watzon/clear, branch: v0.9
  • dotenv0.7.0github: gdotdesign/cr-dotenv
  • micrate0.8.0github: amberframework/micrate
  • mosquito*github: robacarp/mosquito, branch: master
  • tourmaline*github: protoncr/tourmaline, commit: 287f4d2

Development Dependencies

  • sentry*github: watzon/sentry, branch: masterdev

README

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

Documentation

Read the API docs

Built from the current release. The first visit to a release nobody has asked for starts its build.

Links

This branch

Branch
master
Seen
Jun 10, 2020
Crystal
0.34.0
Indexed
yes

Dependents

No indexed shard depends on this one yet.

Repository

github.com/protoncr/tourmaline-boilerplate

Metadata

Created
Aug 12, 2026
Updated
Aug 15, 2026
Synced
Aug 15, 2026
Versions
1