Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/daniel0130/telegram-ts-bot-template
https://github.com/daniel0130/telegram-ts-bot-template
Last synced: 2 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/daniel0130/telegram-ts-bot-template
- Owner: daniel0130
- License: mit
- Created: 2024-10-22T09:46:17.000Z (23 days ago)
- Default Branch: main
- Last Pushed: 2024-10-26T02:32:57.000Z (20 days ago)
- Last Synced: 2024-10-28T18:38:01.923Z (17 days ago)
- Language: TypeScript
- Size: 263 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# telegram-typescript-bot-template
> Template for Telegram bots written in TypeScript
If you haven't written TypeScript before, don't be scared of it.
It is nearly the same as JavaScript.
But it provides more helpful information before something goes wrong during the runtime.
I learned a lot about JavaScript itself when I started diving into TypeScript.
## Install
```bash
npm install
```
## Start the bot
### Local development
Write to the @BotFather on Telegram and create your bot.
You will get a token that looks like this: `123:abc`.
Use it as an environment variable (for example via `.env` file or `export BOT_TOKEN=123:abc`).
Tip: When you create a separate bot for your development you can use production and development in parallel.
The bot stores persistent data within the `persist` folder.
So also create this folder before starting it for the first time.
```bash
mkdir persist
```
Then go ahead and start the bot
```bash
npm start
```
### Production
See the Dockerfile.
You can build a container using it.
But this repo isn't about containers.
For more information about them, take a look elsewhere.
The container is meant to be used with an environment variable named `BOT_TOKEN`.
The container has one volume (`/app/persist`) which will contain persistent data your bot creates.
Make sure to explicitly use that volume (for example, make sure it's synced or tied to the host in a multi-node setup).
## Basic Folder structure example
- `source` contains your TypeScript source files. Subfolders contain specifics about your implementation
- `bot` may contain files relevant for the telegram bot
- `menu` may contain specifics about the bot, the menu that is shown on /start
- `magic` may contain something relevant for doing magic. It is not relevant to the bot directly, but it is used by it.
- `locales` contains translation strings for your bot. That way it can speak multiple languages.
- `dist` will contain transpiled JavaScript files.
- `persist` will contain persistent data your bot uses. Make sure to keep that data persistent (Backups for example).
## Improve
Do you think something is missing?
Feel free to add it.
Then everyone can learn that even easier than before :)