Viiprogrammer / telegraf-bot-template

My template for bots based on Telegraf

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Telegraf Bot Template

Codacy Badge javascript style guide

Technology stack

Features

  • Hot-reload using Nodemon in dev mode.
  • Code linting with ESLint. Code style standard
  • DI with DI container
  • Component based structure
  • Jest, docker, docker-compose, PM2 configs

Installation

We advise you to install all dev dependencies locally (linters, etc):

npm install

Don't forget to create .env (from .env.example).

Run

To run use:

npm run start

To run the dev version use:

npm run dev

To run the eslint use:

npm run lint

Docker installation

  1. Pull this repo
  2. Run cp .env.example .env
  3. Edit .env file
  4. Run docker-compose up -d

PM2 installation

  1. Pull this repo
  2. Run cp .env.example .env
  3. Edit .env file
  4. Run pm2 start

About

My template for bots based on Telegraf

License:MIT License


Languages

Language:JavaScript 99.3%Language:Dockerfile 0.7%