/flow

Browser-based ePub reader

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0

Flow - Open Source Software (OSS)

Redefine ePub reader

Free. Open source. Browser-based.

Features

  • Grid layout
  • Search in book
  • Image preview
  • Custom typography
  • Highlight and Annotation
  • Theme
  • Share/Download book with link
  • Data export
  • Cloud storage

For planed features, see our roadmap.

Development

Prerequisites

Clone the repo

git clone https://github.com/pacexy/flow

Install the dependencies

pnpm i

Setup the environment variables

Copy and rename all .env.local.examples to .env.local and setup the environment variables.

Run the apps

pnpm dev

Self-hosting

Before self-hosting, you should setup the environment variables.

Docker

You can use docker-compose:

docker compose up -d

Or build the image and run it manually:

docker build -t flow .
docker run -p 3000:3000 --env-file apps/reader/.env.local flow

Contributing

There are many ways in which you can participate in this project, for example:

Credits