Migrate to TypeScript, minor changes and fixes (#46)
* docs: linting, require bun for ts * rf: js -> ts * chore: bump * docs: add ts badge * chore: bump types * fix: add types for context to animal commands * [m] hf: add bot type * fix/types: add bot, ctx types, fix emoji on /dice cmd, add todo * fix/types: bot admin checking fixes, other misc fixes, add types --------- Co-authored-by: Lucas Gabriel <lucmsilva651@gmail.com>
This commit is contained in:
parent
6fd5652afa
commit
07045d8e09
32 changed files with 550 additions and 325 deletions
24
README.md
24
README.md
|
@ -2,6 +2,7 @@
|
|||
|
||||
[](CODE_OF_CONDUCT.md)
|
||||
[](https://github.com/abocn/TelegramBot/blob/main/LICENSE)
|
||||
[](https://www.typescriptlang.org)
|
||||
[](https://github.com/abocn/TelegramBot/actions/workflows/github-code-scanning/codeql)
|
||||
[](https://github.com/abocn/TelegramBot/actions/workflows/dependabot/dependabot-updates)
|
||||
|
||||
|
@ -14,7 +15,7 @@ Kowalski is a a simple Telegram bot made in Node.js.
|
|||
> [!IMPORTANT]
|
||||
> You will only need all of them if you are not running it dockerized. Read ["Running with Docker"](#running-with-docker) for more information.
|
||||
|
||||
- Node.js 23 or newer (you can also use [Bun](https://bun.sh))
|
||||
- [Bun](https://bun.sh) (latest is suggested)
|
||||
- A Telegram bot (create one at [@BotFather](https://t.me/botfather))
|
||||
- FFmpeg (only for the `/yt` command)
|
||||
- Docker and Docker Compose (only required for Docker setup)
|
||||
|
@ -27,18 +28,20 @@ First, clone the repo with Git:
|
|||
git clone --recurse-submodules https://github.com/ABOCN/TelegramBot
|
||||
```
|
||||
|
||||
Next, inside the repository directory, create a `config.env` file with some content, which you can see the [example .env file](config.env.example) to fill info with. To see the meaning of each one, see [the Functions section](#configenv-functions).
|
||||
Next, inside the repository directory, create an `.env` file with some content, which you can see the [example .env file](.env.example) to fill info with. To see the meaning of each one, see [the Functions section](#env-functions).
|
||||
|
||||
After editing the file, save all changes and run the bot with ``npm start``.
|
||||
After editing the file, save all changes and run the bot with ``bun start``.
|
||||
|
||||
> [!TIP]
|
||||
> To deal with dependencies, just run ``npm install`` or ``npm i`` at any moment to install all of them.
|
||||
> To deal with dependencies, just run ``bun install`` or ``bun i`` at any moment to install all of them.
|
||||
|
||||
## Running with Docker
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Please complete the above steps to prepare your local copy for building. You do not need to install FFmpeg on your host system.
|
||||
|
||||
---
|
||||
|
||||
> [!NOTE]
|
||||
> Using the `-d` flag when running causes Kowalski to run in the background. If you're just playing around or testing, you may not want to use this flag.
|
||||
|
||||
|
@ -46,7 +49,7 @@ You can also run Kowalski using Docker, which simplifies the setup process. Make
|
|||
|
||||
### Using Docker Compose
|
||||
|
||||
1. **Make sure to setup your `config.env` file first!**
|
||||
1. **Make sure to setup your `.env` file first!**
|
||||
|
||||
2. **Run the container**
|
||||
|
||||
|
@ -58,7 +61,7 @@ You can also run Kowalski using Docker, which simplifies the setup process. Make
|
|||
|
||||
If you prefer to use Docker directly, you can use these instructions instead.
|
||||
|
||||
1. **Make sure to setup your `config.env` file first!**
|
||||
1. **Make sure to setup your `.env` file first!**
|
||||
|
||||
2. **Build the image**
|
||||
|
||||
|
@ -69,12 +72,13 @@ If you prefer to use Docker directly, you can use these instructions instead.
|
|||
3. **Run the container**
|
||||
|
||||
```bash
|
||||
docker run -d --name kowalski --restart unless-stopped -v $(pwd)/config.env:/usr/src/app/config.env:ro kowalski
|
||||
docker run -d --name kowalski --restart unless-stopped -v $(pwd)/.env:/usr/src/app/.env:ro kowalski
|
||||
```
|
||||
|
||||
## config.env Functions
|
||||
## .env Functions
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Take care of your ``config.env`` file, as it is so much important and needs to be secret (like your passwords), as anyone can do whatever they want to the bot with this token!
|
||||
> Take care of your ``.env`` file, as it is so much important and needs to be secret (like your passwords), as anyone can do whatever they want to the bot with this token!
|
||||
|
||||
- **botSource**: Put the link to your bot source code.
|
||||
- **botPrivacy**: Put the link to your bot privacy policy.
|
||||
|
@ -99,7 +103,7 @@ chmod +x src/plugins/yt-dlp/yt-dlp
|
|||
## Contributors
|
||||
|
||||
<a href="https://github.com/abocn/TelegramBot/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=abocn/TelegramBot" />
|
||||
<img src="https://contrib.rocks/image?repo=abocn/TelegramBot" alt="Profile pictures of Kowalski contributors" />
|
||||
</a>
|
||||
|
||||
Made with [contrib.rocks](https://contrib.rocks).
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue