<h1 align="center">

  <a href="https://www.tgscan.xyz"><img style="margin-top: 25px" src="web-app/public/download.svg" width="200"/></a>
 
</h1>

<p align="center" style="margin-top: 20px">
  <span>English</span>
  <span> | </span>
  <a href="README_cn.md">中文</a>
</p>
<h4 align="center">Streamline Your Telegram Searches: Find Channels, Groups, and Chat History Effortlessly.</h4>

<h4 align="center">
  <a href="https://github.com/tgscan-dev/tgscan/actions/workflows/main.yml">
    <img src="https://img.shields.io/github/actions/workflow/status/tgscan-dev/tgscan/main.yml?branch=main&label=pipeline&style=flat-square" alt="continuous integration">
  </a>


  <a href="https://github.com/tgscan-dev/tgscan/graphs/contributors">
    <img src="https://img.shields.io/github/contributors-anon/tgscan-dev/tgscan?color=yellow&style=flat-square" alt="contributers">
  </a>


  <a href="https://www.gnu.org/licenses/gpl-3.0)">
    <img src="https://img.shields.io/badge/License-GPLv3-blue.svg?style=flat-square" alt="license">
  </a>
</h4>

<p align="center">
  <a href="#key-features">Key Features</a> •
  <a href="#how-to-use">How To Use</a> •
  <a href="#credits">Credits</a> •
  <a href="#contribution">Contribution</a> •
  <a href="#license">License</a> •
  <a href="#contact">Contact</a>
</p>

<p align="center">

 ![screenshot](icon/demo.gif)
</p>


## Key Features

- Fast search results
- Intuitive search interface
- Ability to search chat history
- Text Classification for Groups, Channels and Bots
- Near-real-time indexing for up-to-date search results

## How To Use

To get started, visit [setup.md](setup.md) for detailed setup instructions.

## Credits

This software uses the following open source packages:

- [LangChain](https://github.com/hwchase17/langchain)
- [HanLP](https://github.com/hankcs/HanLP)
- [React](https://github.com/facebook/react)
- [Ramda](https://github.com/ramda/ramda)
- [Polaris](https://github.com/Shopify/polaris)
- [Telethon](https://github.com/LonamiWebs/Telethon)
- [Elasticsearch](https://github.com/elastic/elasticsearch)

## Contribution

Welcome to submit code or any channels that need indexing.

## License

This project is licensed under the GNU License. See the [LICENSE](LICENSE) file for details.

## Contact

 <a href="https://t.me/tgscan_dev">
    <img src="https://img.shields.io/badge/Telegram-26A5E4.svg?style=for-the-badge&logo=Telegram&logoColor=white"
         alt="Telegram">
  </a>


