Skip to content

Commit

Permalink
✨ feat: add README.md with information about Kitan Telegram bot guardian
Browse files Browse the repository at this point in the history
  • Loading branch information
sudoskys committed May 13, 2024
1 parent 68ae314 commit 30ff134
Showing 1 changed file with 87 additions and 0 deletions.
87 changes: 87 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# 🌟 Kitan

---
<p align="center">
<img alt="License" src="https://img.shields.io/badge/LICENSE-Apache%202.0-blue.svg" />
<img src="https://img.shields.io/badge/Python-3.9%2B-green.svg" alt="Python 3.9+" />
<a href="/~https://github.com/TelechaBot/Kitan/releases"><img src="https://img.shields.io/github/v/release/TelechaBot/Kitan?style=plastic" alt="Version" ></a>
</p>

**Kitan** is a Telegram bot guardian responsible for ensuring that users are friendly real human beings. It is an
open-source project developed using Python and Vue.

πŸ‘‹ User-friendly and incorporating risk control technology, Kitan provides a safe and pleasant chat environment,
effectively preventing personal attacks and advertisements from real human harassments.

[Invite the bot to your group](https://t.me/SmartVerifyBot?startgroup&admin=can_invite_users+restrict_members+delete_messages)

### πŸš€ Why Choose Kitan

Traditional verification methods like captchas, security questions, and puzzles can be circumvented with human
assistance. Moreover, not all advertisement senders are bots; real users may also send ads.

Hence, we need a verification method tailored to the current environment, ensuring that users are within the platform
and have undergone self-defense testing.

Kitan achieves this by using quick fingerprint verification and puzzle proof-of-work within the authentication mechanism
to ensure users are real humans.

Additionally, Kitan employs risk control techniques, combining LLM/NLP/big data technologies for AI behavior analysis,
monitoring user behavior from joining to leaving groups, effectively preventing personal attacks and real human
advertisement harassment.

## πŸ›‘οΈ Verification Methods

- [x] Biometric live authentication
- [x] Puzzle proof-of-work verification

## πŸ“š How to Use

1. Add the bot to your group
2. Set the bot as an administrator
3. Grant the bot the necessary permissions
4. The bot will automatically review new group members

The bot implements an approval-based invite mechanism, allowing only approved users to join the group, preventing
situations where user approvals are hindered due to bot malfunctions.

## πŸ›£οΈ Roadmap

- [x] Implement basic verification
- [ ] Risk control system/ban monitoring/pre-inspection
- [ ] Group consensus
- [ ] Persistent tokens/Github-hosted verification

## πŸ“¦ Deploying Your Own Instance

You will need a server with `Redis` and `MongoDB` installed, a domain, and a Telegram bot.

```shell
git clone /~https://github.com/TelechaBot/Kitan
cd Kitan
```

**Frontend**

```shell
cd frontend
npm install
env VITE_BACKEND_URL="https://api.example.com"
npm run build
# Deploy to server
```

**Backend**

```shell
cd backend

cp .env.example .env
nano .env

pip install pdm
pdm install
pdm run python main.py
# Press Ctrl + C to exit
pm2 start pm2.json
```

0 comments on commit 30ff134

Please sign in to comment.