Skip to content

ali-sefidmouy/shieldy

 
 

Repository files navigation

@shieldy_bot

@shieldy_bot Telegram bot code

This is the code for the anti-spam Telegram bot I've built. Enjoy and feel free to reuse!

Installation

Local launch

  1. Clone this repo: git clone https://github.com/backmeupplz/shieldy
  2. Launch the mongo database locally
  3. Create .env with the environment variables listed below
  4. Run yarn install in the root folder
  5. Run yarn distribute

And you should be good to go! Feel free to fork and submit pull requests. Thanks!

Docker

  1. Clone this repo: git clone https://github.com/backmeupplz/shieldy
  2. Replace the dummy environment variables in docker-compose.yml with the ones listed below
  3. Run docker-compose up -d

Environment variables

  • TOKEN — Telegram bot token
  • MONGO— URL of the mongo database

Also, please, consider looking at .env.sample.

Continuous integration

Any commit pushed to master gets deployed to @shieldy_bot via CI Ninja.

License

MIT — use for any purpose. Would be great if you could leave a note about the original developers. Thanks!

About

@shieldy_bot Telegram bot repository

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 98.9%
  • Other 1.1%