Skip to content

Commit

Permalink
doc: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
liou666 committed Dec 14, 2023
1 parent d043484 commit f66dc81
Show file tree
Hide file tree
Showing 2 changed files with 196 additions and 4 deletions.
180 changes: 180 additions & 0 deletions README-EN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
# <img src="./public/favicon.ico" width="60px" align="center" alt="Polyglot icon"> Polyglot
> Cross-platform AI language practice app

<p align="left">
<a href="https://github.com/liou666/polyglot/releases" target="_blank">
<img alt="macOS" src="https://img.shields.io/badge/-macOS-black?style=flat-square&logo=apple&logoColor=white" />
</a>
<a href="https://github.com/liou666/polyglot/releases" target="_blank">
<img alt="Windows" src="https://img.shields.io/badge/-Windows-blue?style=flat-square&logo=windows&logoColor=white" />
</a>
<a href="https://github.com/liou666/polyglot/releases" target="_blank">
<img alt="Linux" src="https://img.shields.io/badge/-linux-red?style=flat-square&logo=linux&logoColor=white" />
</a>
<a href="https://github.com/liou666/polyglot/releases" target="_blank">
<img alt="Downloads" src="https://img.shields.io/github/downloads/liou666/polyglot/total.svg?style=flat" />
</a>
</p>

<p align="left">
<a href="./README.md">
简体中文
</a>
/
<a href="./README-EN.md">
English
</a>
</p>


Polyglot is a cross-platform desktop application (currently supporting the [web version](https://polyglotai.xyz)). It is based on ChatGPT and Azure Artificial Intelligence language models as underlying services, aiming to provide an easy-to-use language practice platform for convenient multilingual oral exercises.

<p align="center">
<img width="" alt="Screenshot: Polyglot App running" src="./screenshot/main1.png">
</p>


## Download
- **Mac**: [Apple](https://github.com/liou666/polyglot/releases/download/v0.3.6/Polyglot_arm64_0.3.6.dmg) [Intel](https://github.com/liou666/polyglot/releases/download/v0.3.6/Polyglot_x64_0.3.6.dmg)
- **Windows**: [Download](https://github.com/liou666/polyglot/releases/download/v0.3.6/Polyglot_0.3.6.exe)
- **Linux**: [Download](https://github.com/liou666/polyglot/releases/download/v0.3.6/Polyglot_0.3.6.AppImage)
- **Web Version**[Online Link](https://polyglotai.xyz)


## Software Screenshots
<details>
<summary>Expand</summary>


<p align="center">
<img width="" alt="Screenshot: Polyglot App running" src="./screenshot/new.png">
</p>

<!-- <p align="center">
<img width="" alt="Screenshot: Polyglot App running" src="./screenshot/main1-light.png">
</p> -->

<p align="center">
<img width="" alt="Screenshot: Polyglot App running" src="./screenshot/setting_chat.png">
</p>
<p align="center">
<img width="" alt="Screenshot: Polyglot App running" src="./screenshot/setting_voice.png">
</p>
<p align="center">
<img width="" alt="Screenshot: Polyglot App running" src="./screenshot/export.png">
</p>

</details>

## Features
- [x] Multilingual oral practice (~~Currently built-in AI characters from four different countries, namely the United States, Japan, South Korea, and France. More languages may be added in the future~~)(Built-in English, other languages now support customization)
- [x] Smart voice synthesis (currently based on Azure TTS service, considering integrating locally deployable voice models in the future)
- [x] Smart conversation feature (based on chatGPT service)
- [x] Dark mode support
- [x] Integration of text translation feature
- [x] Support user-customized languages and AI characters
- [x] User-customizable Azure key configuration
- [x] Custom avatars
- [x] Voice recognition with keyboard shortcuts (press and hold the space bar to start voice recognition, release the space bar to end voice recognition)

- [x] Support user-configurable custom conversation scenarios
- [x] Self-voice playback support
- [ ] Support Azure openai API, claude API services (Azure openai API is already supported)
- [x] [Web Version](https://polyglotai1.xyz) (Currently not highly compatible with mobile devices!)
- [x] Support for AI reply content fuzzing
- [x] Highlight corresponding words based on playback progress during voice playback
- [x] AI provides reply suggestions


## Usage
+ Set up[OpenAI Key](https://platform.openai.com/account/api-keys)
+ Set up a proxy (optional)
+ Set up [azure key](https://portal.azure.com/)
+ Create a new AI character for conversation
+ Practice speaking with AI characters.

## Development
```bash
# 1. Clone this repository;
git clone https://github.com/liou666/polyglot.git

# 2. Install dependencies;
cd polyglot
pnpm install
# If the installation of electron fails, try installing with Taobao mirror source👇:
# export ELECTRON_MIRROR=http://npm.taobao.org/mirrors/electron/ && pnpm i

# 3. Configure relevant environment variables according to the comments
mv .env.example .env

# 4. Start the service
pnpm dev
```



## License
[GNU General Public License v3.0](./LICENSE)

# Contributors
<div>
<a href="https://github.com/liou666/polyglot/graphs/contributors">
<img src="https://contrib.rocks/image?repo=liou666/polyglot" />
</a>
</div>

## Frequently Questions


<details>
<summary>1. macOS prompts "Polyglot" cannot be opened because Apple cannot check it for malicious software.</summary>

This error is due to the Gatekeeper security feature in the macOS operating system preventing the application from running.
To resolve this issue, follow these steps:

Open "System Preferences" and click on "Security & Privacy."
In the "General" tab, you will see a message: "Polyglot" was blocked. Click on "Open Anyway."
Alternatively, you can click "Open Anyways" to open your application.
(Admin permissions may be required to open the application.)

If you don't want to perform these steps every time you open the application, you can add the application to the whitelist to run without being blocked. To add your application to the whitelist, do the following:

Open Terminal and enter the following command:

```sh
xattr -rd com.apple.quarantine /path/to/Polyglot.app
```
Here, /path/to/Polyglot.app is the full path to your application.

After running the command, the application will be added to the whitelist, and Gatekeeper will no longer block its execution.
</details>
<details>
<summary>2. How to apply for Azure Speech Service?</summary>

To apply for an API key for Azure Speech Service, you can follow these steps:

+ Log in to the Azure portal (https://portal.azure.com/)
+ Go to the "Azure Speech Service" page and click the "Add" button.
+ In the "Create Azure Speech Service" window, choose your subscription, resource group, region, and specify a name for the new service.
+ Select the "F0" pricing tier and click "Create."
+ Once created, go to the "Overview" page of the new service to view the key and endpoint.

</details>

## Donations
If you find the project helpful, feel free to buy me a cup of tea 😊。

<table>
<tr>
<!-- <th>爱发电</th> -->
<th>WeChat</th>
<th>Alipay</th>
</tr>
<tr>
<!-- <td><a target="_blank" href="https://afdian.net/a/liou666">爱发电</a</td> -->
<td><img width="300" height="300" alt="" src="./public/donate/zsm.jpg"></td>
<td><img width="300" height="300" alt="" src="./public/donate/alipay.jpg"></td>
</tr>
</table>

20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# <img src="./public/favicon.ico" width="60px" align="center" alt="Polyglot icon"> Polyglot
> AI语言练习应用
> 跨平台AI语言练习应用

<p align="left">
Expand All @@ -15,6 +15,17 @@
<a href="https://github.com/liou666/polyglot/releases" target="_blank">
<img alt="Downloads" src="https://img.shields.io/github/downloads/liou666/polyglot/total.svg?style=flat" />
</a>

</p>

<p align="left">
<a href="./README.md">
简体中文
</a>
/
<a href="./README-EN.md">
English
</a>
</p>

Polyglot是一款跨平台的桌面端应用程序(目前已支持[web版本](https://polyglotai.xyz))。基于ChatGPT和Azure人工智能语言模型作为底层服务,旨在提供一个易于使用的语言练习平台,方便进行多语种的口语练习。 ( [📺 B站视频链接](https://www.bilibili.com/video/BV1Ym4y1a7et) )
Expand All @@ -26,11 +37,12 @@ Polyglot是一款跨平台的桌面端应用程序(目前已支持[web版本](


## 下载
- **Mac**: [点击下载](https://github.com/liou666/polyglot/releases/download/v0.3.5/Polyglot_0.3.5.dmg)
- **Windows**: [点击下载](https://github.com/liou666/polyglot/releases/download/v0.3.5/Polyglot_0.3.5.exe)
- **Linux**: [点击下载](https://github.com/liou666/polyglot/releases/download/v0.3.5/Polyglot_0.3.5.AppImage)
- **Mac**: [Apple](https://github.com/liou666/polyglot/releases/download/v0.3.6/Polyglot_arm64_0.3.6.dmg) [Intel](https://github.com/liou666/polyglot/releases/download/v0.3.6/Polyglot_x64_0.3.6.dmg)
- **Windows**: [点击下载](https://github.com/liou666/polyglot/releases/download/v0.3.6/Polyglot_0.3.6.exe)
- **Linux**: [点击下载](https://github.com/liou666/polyglot/releases/download/v0.3.6/Polyglot_0.3.6.AppImage)
- **Web版本**[在线地址](https://polyglotai.xyz)


## 软件截图
<details>
<summary>展开</summary>
Expand Down

0 comments on commit f66dc81

Please sign in to comment.