<h2 align="center">myGPTReader</h2>
<div align="center">

[![Status](https://img.shields.io/badge/status-active-success.svg)]()
[![GitHub Actions](https://github.com/madawei2699/myGPTReader/actions/workflows/fly.yml/badge.svg)]()
[![GitHub Issues](https://img.shields.io/github/issues/madawei2699/myGPTReader.svg)](https://github.com/madawei2699/myGPTReader/issues)
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/madawei2699/myGPTReader.svg)](https://github.com/madawei2699/myGPTReader/pulls)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)

</div>
<p align="center">
    <br> English | <a href="README-CN.md">中文</a>
</p>
<p align="center">
    <em>A community-driven way to read and chat with AI bots - powered by chatGPT.</em>
</p>

> 💡 The exciting part is that the development of this project is also paired with chatGPT. I document the development process in this [CDDR](docs/CDDR.md) file.

---

## 📝 Table of Contents

- [📝 Table of Contents](#-table-of-contents)
- [🧐 About ](#-about-)
- [🏁 Getting Started ](#-getting-started-)
- [🔥 Main Features ](#-main-features-)
  - [📖 Website read with myGPTReader](#-website-read-with-mygptreader)
  - [📚 Document read with myGPTReader](#-document-read-with-mygptreader)
  - [🗣️ Voice chat with myGPTReader](#️-voice-chat-with-mygptreader)
  - [💬 Ask myGPTReader anything](#-ask-mygptreader-anything)
  - [🔥 Hot News Today](#-hot-news-today)
- [How to Install ](#how-to-install-)
- [✍️ Authors ](#️-authors-)
- [🎉 Acknowledgements ](#-acknowledgements-)
- [Reference Links ](#reference-links-)
- [Star History ](#star-history-)

## 🧐 About <a name = "about"></a>

<table style="border-collapse: collapse; border: none;">
  <tbody>
    <tr>
        <td>
          <img src="./web/landing/logo/my-gpt-reader-logo-1-removebg.png" data-canonical-src="./web/landing/logo/my-gpt-reader-logo-1-removebg.png"/>
        </td>
        <td>
          myGPTReader is a bot on Slack that can read and summarize any webpage, documents including ebooks, or even videos from YouTube. It can communicate with you through voice.
        </td>
    </tr>
  </tbody>
</table>

## 🏁 Getting Started <a name = "getting_started"></a>

Please join this [Slack channel](https://slack-redirect.i365.tech/) with more than 5000+ members to experience all these features for free.

## 🔥 Main Features <a name="main_features"></a>

### 📖 Website read with myGPTReader

Use myGPTReader to quickly read and understand any web content through conversations, even videos (currently only YouTube videos with subtitles are supported).

![Web read with myGPTReader - web page](https://user-images.githubusercontent.com/2446612/229781090-2be95df8-5197-4209-85a0-3753582f9b4e.gif)
![Web read with myGPTReader - video](https://user-images.githubusercontent.com/2446612/229781120-9fb9d94f-e545-40c1-a947-4a0131594911.gif)


### 📚 Document read with myGPTReader

Use myGPTReader to quickly read the content of any file, supporting eBooks, PDF, DOCX, TXT, and Markdown.

![Document read with myGPTReader](https://user-images.githubusercontent.com/2446612/229781163-cffd2d8b-4ee7-47b5-b970-37dd008c498b.gif)


### 🗣️ Voice chat with myGPTReader

Practice your foreign language by speaking with your voice to myGPTReader, which can be your personal tutor and supports Chinese, English, German, and Japanese.

![Voice chat with myGPTReader](https://user-images.githubusercontent.com/2446612/229781224-0267b06a-220a-488a-bc08-6e4d02cd6552.gif)


### 💬 Ask myGPTReader anything

A large number of prompt templates are built in, use them for better conversations with chatGPT.

![Ask myGPTReader anything](https://user-images.githubusercontent.com/2446612/229781297-a9404652-8f6c-4443-a645-e99bf50db7b1.gif)

### 🔥 Hot News Today

Every day myGPTReader sends out the latest hot news and automatically generates a summary, so you can quickly learn what's hot today.
  
![Hot News Today](https://user-images.githubusercontent.com/2446612/228729812-38c3137a-026e-4100-9fab-0b8f2a1215fc.gif)

## How to Install <a name = "how_to_install"></a>

How to deploy myGPTReader on your own server.
(WIP)

## ✍️ Authors <a name = "authors"></a>

- [@madawei2699](https://twitter.com/madawei2699)
<img src="https://github.com/madawei2699/myGPTReader/assets/2446612/0a50a222-74cf-490f-a3ad-613cbc5ebf91" alt="improve365_cn" style="width:200px;"/>

See also the list of [contributors](https://github.com/madawei2699/myGPTReader/contributors) who participated in this project.

## 🎉 Acknowledgements <a name = "acknowledgement"></a>

- Hat tip to anyone whose code was used

## Reference Links <a name = "reference_links"></a>

- YouTube video for myGPTReader main features showcase
  
  [![myGPTReader showcase](http://img.youtube.com/vi/qKS5Wwhrf5E/0.jpg)](https://youtu.be/qKS5Wwhrf5E)

- YouTube Live video for in-depth walkthrough of the project.
  
  [![myGPTReader Live Share](http://img.youtube.com/vi/XZIogwFU7jE/0.jpg)](https://www.youtube.com/live/XZIogwFU7jE?feature=share "myGPTReader Live Share")

Blog post:

- [我的 AI 阅读助手](https://www.bmpi.dev/self/my-gpt-reader/)
- [ChatGPT应用开发小记](https://www.bmpi.dev/dev/chatgpt-development-notes/my-gpt-reader/)

## Star History <a name = "star_history"></a>

[![Star History Chart](https://api.star-history.com/svg?repos=madawei2699/myGPTReader&type=Date)](https://star-history.com/#madawei2699/myGPTReader&Date)

---

Maintained by the creator of **MyInvestPilot**  
https://www.myinvestpilot.com
