Repository files navigation

Free. Open source. Browser-based.

• 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 ourroadmap.

• Node.js
• pnpm
• Git

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

pnpm i

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

pnpm dev

Before self-hosting, you shouldsetup the environment variables.

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

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

• Submit bugs and feature requests, and help us verify as they are checked in
• Submit pull requests

• Epub.js
• React
• Next.js
• TypeScript
• Vercel
• Turborepo