# koodo-reader

**Repository Path**: yjcf/koodo-reader

## Basic Information

- **Project Name**: koodo-reader
- **Description**: 📚 跨平台的电子书阅读器，平台支持Windows，macOS，Linux 和网页版，格式支持 epub，pdf，mobi，azw3 和 txt，支持数据导入导出和网盘同步。基于 React、Redux、TypeScript、Electron、i18n
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://koodo.960960.xyz/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 28
- **Created**: 2021-02-28
- **Last Updated**: 2021-10-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">

[简体中文](https://github.com/troyeguo/koodo-reader/blob/master/README_cn.md) | [繁體中文](https://github.com/troyeguo/koodo-reader/blob/master/README_tw.md) | English

</div>

<div align="center" width="128px" height="128px">
<img src="https://i.loli.net/2020/04/26/wrO8EPokvUQWaf5.png" />
</div>

<h1 align="center">
  Koodo Reader
</h1>
<h3 align="center">
  A cross-platform ebook reader
</h3>
<div align="center">

[Download](https://koodo.960960.xyz/download) | [Website](https://koodo.960960.xyz)

</div>

<div align="center">
  <a href="https://github.com/troyeguo/koodo-reader/releases/latest">
    <img src="https://img.shields.io/github/release/troyeguo/koodo-reader.svg?style=flat-square" alt="">
  </a>

  <a href="https://github.com/troyeguo/koodo-reader/blob/master/LICENSE">
    <img src="https://img.shields.io/github/license/troyeguo/koodo-reader.svg?style=flat-square" alt="">
  </a>
</div>

## Preview

<div align="center">
  <a href="https://github.com/troyeguo/koodo-reader/releases/latest">
    <img src="https://i.loli.net/2021/02/13/JkIpcnlqNAW5bEy.png" >
  </a>
  <a href="https://github.com/troyeguo/koodo-reader/releases/latest">
    <img src="https://i.loli.net/2021/02/13/nZxD7yOvw39BJNA.png" >
  </a>
  <br/>
</div>

## Feature

Format support: **epub** , **pdf**, **mobi**, **azw3**, and **txt**

Platform support: **Windows** , **macOS**, **Linux** and **Web**

Save your data to **Dropbox** or **Webdav**

Customize the source folder and synchronize multiple devices using OneDrive, iCloud, Dropbox, etc.

Single-column, two-column, or continuous scrolling layouts

Text-to-speech, Translation

Bookmark, Note, Digest, Shelf and Tag

Adjust font, line-spacing, background color, text color and margins

Support for Touch Screen

Text highlight and underline

Language support: Simplified Chinese, Traditional Chinese and English

## Installation

Desktop Version: [Download](https://koodo.960960.xyz/download)

Web Version：[Preview](https://reader.960960.xyz)

Install with [Homebrew](https://brew.sh/):

```shell
brew install --cask koodo-reader
```

## Develop

Make sure node's version on your computer is larger than 10.0.0, yarn and git is in place.

1. Download the repo

   ```
   git clone https://github.com/troyeguo/koodo-reader.git
   ```

2. Enter desktop mode

   ```
   yarn
   yarn dev
   ```

3. Enter web mode

   ```
   yarn
   yarn start
   ```
## Docker

You can run in docker compose

```bash
docker-compose up -d
```

## Update

You will receive an update notification when you open the software.

## Contribution

| Contribution                        | Contributor                                                                                |
| :---------------------------------- | :----------------------------------------------------------------------------------------- |
| translation for traditional Chinese | [TobySkarting](https://github.com/TobySkarting), [playercd8](https://github.com/playercd8) |
| installation for Homebrew           | [singularitti](https://github.com/singularitti)                                            |
| other contributors                  | [bamlan](https://github.com/bamlan)                                                        |

## Help

Click [here](https://github.com/troyeguo/koodo-reader/issues) to report your issue, or visit [Website](https://koodo.960960.xyz/support) for more instruction.

## Sponsor

If you found this project helpful, please consider giving us a star.