abocn/kowalski
3
0
Fork 0
mirror of https://github.com/abocn/TelegramBot.git synced 2025-04-28 17:15:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: linting and convert bullet point to tip

Browse Source
This commit is contained in:
Aidan 2025-04-14 00:57:04 -04:00
parent 7750b522ab
commit 3f71d0c8ca
1 changed files with 20 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -1,30 +1,40 @@
# Kowalski (Node.js Telegram Bot) # Kowalski (Node.js Telegram Bot)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
![GitHub License](https://img.shields.io/github/license/ABOCN/TelegramBot) ![GitHub License](https://img.shields.io/github/license/ABOCN/TelegramBot)
Kowalski is a a simple Telegram bot made in Node.js. Kowalski is a a simple Telegram bot made in Node.js.
- You can find Kowalski at [@KowalskiNodeBot](https://t.me/KowalskiNodeBot) on Telegram.
- You can find Kowalski at [@KowalskiNodeBot](https://t.me/KowalskiNodeBot) on Telegram.
## Self-host requirements ## Self-host requirements
- Node.js 20 or newer (you can also use Bun)
- A Telegram bot (create one at [@BotFather](https://t.me/botfather)) - Node.js 20 or newer (you can also use Bun)
- Latest version of Node.js - A Telegram bot (create one at [@BotFather](https://t.me/botfather))
- FFmpeg (only for the /yt command) - Latest version of Node.js
- FFmpeg (only for the `/yt` command)
## Run it yourself, develop or contribute with Kowalski ## Run it yourself, develop or contribute with Kowalski
First, clone the repo with Git: First, clone the repo with Git:
```
```bash
git clone https://github.com/ABOCN/TelegramBot git clone https://github.com/ABOCN/TelegramBot
``` ```
And now, init the submodules with these commands (this is very important): And now, init the submodules with these commands (this is very important):
```
```bash
cd TelegramBot cd TelegramBot
git submodule update --init --recursive git submodule update --init --recursive
``` ```
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 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).
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 ``npm start``.
- To deal with dependencies, just run ``npm install`` or ``npm i`` at any moment to install all of them.
> [!TIP]
> To deal with dependencies, just run ``npm install`` or ``npm i`` at any moment to install all of them.
## config.env Functions ## config.env Functions
- **botSource**: Put the link to your bot source code. - **botSource**: Put the link to your bot source code.
@ -34,7 +44,9 @@ After editing the file, save all changes and run the bot with ``npm start``.
- **weatherKey**: Weather.com API key, used for the `/weather` command. - **weatherKey**: Weather.com API key, used for the `/weather` command.
## Note ## Note
- 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 ``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!
## About/License ## About/License
BSD-3-Clause - 2024 Lucas Gabriel (lucmsilva). BSD-3-Clause - 2024 Lucas Gabriel (lucmsilva).