Wondering whatโ€™s next for npm?Check out our public roadmap! ยป

    TypeScript icon, indicating that this package has built-in type declarations

    1.0.20210412ย โ€ขย Publicย โ€ขย Published

    ๐Ÿค– node-telegram-bot-boilerplate

    v1.0.20210412 License: MIT Language: TypeScript ECMAScript: 2019 Discord Server

    Create your telegram bot with this friendly boilerplate. Use this repository as template for your bot

    This is a github template, you can fork it or use as template for start new project with this repository as hello-world. I hate start new project with empty template, often i missing correct configuration, readme instruction or i need of samples of code. Use this repository as template solve this problem.

    ๐ŸŽ Support: Donate

    This project is free, open source and I try to provide excellent free support. Why donate? I work on this project several hours in my spare time and try to keep it up to date and working. THANK YOU!

    Donate Paypal Donate Ko-Fi Donate Github Sponsors Donate Patreon Donate Bitcoin Donate Ethereum

    ๐Ÿ“Ž Menu

    ๐Ÿ’ก Features

    • [โœ”๏ธ] Easy to use
    • [โœ”๏ธ] MIT License
    • [โœ”๏ธ] Make telegram bot with node
    • [โœ”๏ธ] Friendly boilerplate + Github templates
    • [โœ”๏ธ] Typescript + TSPaths preconfigured
    • [โœ”๏ธ] Userfriendly folders tree
    • [โœ”๏ธ] Prettiers and ESLint preconfigured
    • [โœ”๏ธ] all-contributors-cli and all-shields-cli preconfigured
    • [โœ”๏ธ] JEST Test preconfigured
    • [โœ”๏ธ] Full async code
    • [โœ”๏ธ] Github and Vscode dotfiles preconfigured
    • [โœ”๏ธ] Translations: ๐Ÿ‡ฌ๐Ÿ‡ง ๐Ÿ‡ฎ๐Ÿ‡น ๐Ÿ‡ต๐Ÿ‡ฑ (Help me โค๏ธ)

    ๐Ÿ”จ Developer Mode

    ๐Ÿ Run Project

    1. Clone this repository or download nightly, beta or stable.
    2. Write to @botfather on telegram and create new bot (save token and set bot username)
    3. Run with correct values: npm run init:token --username name_bot --token 1234:asdfghjkl
    4. Run npm run init
    5. Run npm run dev
    6. Write /start on telegram bot.

    ๐Ÿ’พ Setup Project

    If you want replace all strings (example: package name, author, urls, etc...) in markdown file, source files and others files of this project you need edit setup.json with correct values and run npm run setup.

    ๐Ÿš€ Deploy

    Deploy bot to your server and:

    1. Run with correct values: npm run init:token --token asdfghjkl
    2. Run init npm run init
    3. Generate release npm run release
    4. Start bot npm run start-pm2

    ๐Ÿ“š Documentation

    Run npm run docs

    ๐Ÿ‘‘ Backers and Sponsors

    Thanks to all our backers! ๐Ÿ™ Donate 3$ or more on paypal, ko-fi, github or patreon and send me email with your avatar and url.

    ๐Ÿ‘จโ€๐Ÿ’ป Contributing

    I โค๏ธ contributions! I will happily accept your pull request! Translations, grammatical corrections (GrammarNazi you are welcome! Yes my English is bad, sorry), etc... Do not be afraid, if the code is not perfect we will work together ๐Ÿ‘ฏ and remember to insert your name in .all-contributorsrc and package.json file.

    Thanks goes to these wonderful people (emoji key):

    Patryk Rzucidล‚o

    ๐Ÿ’ป ๐ŸŒ ๐Ÿ“– ๐Ÿ›

    ๐Ÿ’ฐ In the future, if the donations allow it, I would like to share some of the success with those who helped me the most. For me open source is share of code, share development knowledges and share donations!

    ๐Ÿฆ„ Other Projects

    ๐Ÿ’ซ License

    • Code and Contributions have MIT License
    • Images and logos have CC BY-NC 4.0 License
    • Documentations and Translations have CC BY 4.0 License
    Copyleft (c) 2021 Patryk Rzucidล‚o (@PTKDev) <support@ptkdev.io>


    npm i @ptkdev/node-telegram-bot-boilerplate

    DownloadsWeekly Downloads






    Unpacked Size

    55.2 kB

    Total Files


    Last publish


    • avatar