https://github.com/backmeupplz/IsBotDownBot

@IsBotDownBot Telegram bot code
https://github.com/backmeupplz/IsBotDownBot

Last synced: 3 months ago
JSON representation

@IsBotDownBot Telegram bot code

• Host: GitHub
• URL: https://github.com/backmeupplz/IsBotDownBot
• Owner: backmeupplz
• License: mit
• Created: 2021-11-01T23:50:39.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-08-29T18:37:34.000Z (about 2 years ago)
• Last Synced: 2024-07-18T15:32:47.393Z (4 months ago)
• Language: TypeScript
• Homepage: https://isbotdown.com
• Size: 112 KB
• Stars: 32
• Watchers: 3
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# [@IsBotDownBot](https://t.me/IsBotDownBot) code

Code of the bot that tracks the up and down status of other bots.

## Installation and local launch

1. Clone this repo: `git clone https://github.com/backmeupplz/IsBotDownBot`

2. Launch the [mongo database](https://www.mongodb.com/) locally

3. Create `.env` with the environment variables listed below

4. Run `yarn` in the root folder

5. Run `yarn develop`

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

## Environment variables

- `TOKEN` — Telegram bot token

- `MONGO` — URL of the mongo database

- `TELEGRAM_API_ID` — see [the docs](https://painor.gitbook.io/gramjs/getting-started/authorization)

- `TELEGRAM_API_HASH` — see [the docs](https://painor.gitbook.io/gramjs/getting-started/authorization)

- `PORT` — port to run the backend on (defaults to `1337`)

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

## API

You can also access API at https://backend.isbotdown.com. Available routes are:

#### GET `/bots?skip={skip}&limit={limit}`

Returns a paginated list of bots with their statuses.

#### GET `/bots/{bot_username}`

Returs the status of the bot with the given username. You can pass usernames with or without the `@` prefix.

#### GET `/audience/{bot_username}`

Returns audience info from [@TrueCheckerBot](https://t.me/TrueCheckerBot) and [@botspulsebot](https://t.me/botspulsebot).

## CI/CD

`main` branch get automatically deployed to [@IsBotDownBot](https://t.me/IsBotDownBot) via [ci-ninja](https://github.com/backmeupplz/ci-ninja).

## License

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