This is a fork of the original Flow ePub reader, with a focus on improving and stabilizing the browser extension.

• Grid layout
• Search in book
• Image preview
• Custom typography
• Highlight and Annotation
• Theme
• Data export
• Cloud storage

Follow these steps to set up the development environment and build the extension from the source code.

• Node.js (v18 or higher)
• pnpm
• Git

git clone https://github.com/Zolangui/Flow-Reader-Extension.git
cd Flow-Reader-Extension

pnpm i

This project uses environment variables for configuration. Copy the example files and fill in the required values.

cp apps/reader/.env.local.example apps/reader/.env.local
# You may need to do this for other apps if you intend to use them.

The extension needs to be built before it can be loaded into a browser.

• For Chrome:

  pnpm build:ext:chrome

• For Firefox:

  pnpm build:ext:firefox

The built extension files will be located in the apps/extension/dist directory.

1. Open Google Chrome and navigate to chrome://extensions.
2. Enable "Developer mode" using the toggle switch in the top-right corner.
3. Click the "Load unpacked" button.
4. In the file dialog, select the apps/extension/dist directory from this project.
5. The "Flow" extension will now be installed.

1. Open Mozilla Firefox and navigate to about:debugging.
2. Click on the "This Firefox" tab on the left.
3. Click the "Load Temporary Add-on..." button.
4. In the file dialog, navigate to the apps/extension/dist directory and select the manifest.json file.
5. The "Flow" extension will now be temporarily installed.

If you want to create a distributable zip file of the extension:

• For Chrome:

  pnpm package:chrome

• For Firefox:

  pnpm package:firefox

All contributions are welcome!

• Submit bugs and feature requests
• Submit pull requests

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