{"id":13457368,"url":"https://github.com/pacexy/flow","last_synced_at":"2025-05-14T04:07:46.943Z","repository":{"id":63506920,"uuid":"481185579","full_name":"pacexy/flow","owner":"pacexy","description":"Browser-based ePub reader","archived":false,"fork":false,"pushed_at":"2025-03-19T00:33:47.000Z","size":4582,"stargazers_count":2631,"open_issues_count":77,"forks_count":206,"subscribers_count":18,"default_branch":"main","last_synced_at":"2025-05-10T00:52:17.789Z","etag":null,"topics":["epub","epub-reader","nextjs","pwa","react","reactjs","reader","typescript"],"latest_commit_sha":null,"homepage":"https://flowoss.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pacexy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":null,"patreon":"pacexy","open_collective":null,"ko_fi":"pacexy","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2022-04-13T11:19:21.000Z","updated_at":"2025-05-09T13:04:53.000Z","dependencies_parsed_at":"2023-10-11T01:00:57.461Z","dependency_job_id":"f31571b6-343e-4a39-8817-79900760721c","html_url":"https://github.com/pacexy/flow","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pacexy%2Fflow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pacexy%2Fflow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pacexy%2Fflow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pacexy%2Fflow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pacexy","download_url":"https://codeload.github.com/pacexy/flow/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254069441,"owners_count":22009551,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["epub","epub-reader","nextjs","pwa","react","reactjs","reader","typescript"],"created_at":"2024-07-31T08:01:41.510Z","updated_at":"2025-05-14T04:07:46.896Z","avatar_url":"https://github.com/pacexy.png","language":"TypeScript","readme":"\u003ch1 align=\"center\"\u003e\u003ca href=\"https://flowoss.com\"\u003eFlow - Open Source Software (OSS)\u003c/a\u003e\u003c/h1\u003e\n\n\u003ch2 align=\"center\"\u003eRedefine ePub reader\u003c/h2\u003e\n\n\u003cp align=\"center\"\u003eFree. Open source. Browser-based.\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"apps/website/public/screenshots/en-US.webp\"/\u003e\n\u003c/p\u003e\n\n## Features\n\n- Grid layout\n- Search in book\n- Image preview\n- Custom typography\n- Highlight and Annotation\n- Theme\n- Share/Download book with link\n- Data export\n- Cloud storage\n\nFor planed features, see our [roadmap](https://pacexy.notion.site/283696d0071c43bfb03652e8e5f47936?v=b43f4dd7a3cb4ce785d6c32b698a8ff5).\n\n## Development\n\n### Prerequisites\n\n- [Node.js](https://nodejs.org)\n- [pnpm](https://pnpm.io/installation)\n- [Git](https://git-scm.com/downloads)\n\n### Clone the repo\n\n```bash\ngit clone https://github.com/pacexy/flow\n```\n\n### Install the dependencies\n\n```bash\npnpm i\n```\n\n### Setup the environment variables\n\nCopy and rename all `.env.local.example`s to `.env.local` and setup the environment variables.\n\n### Run the apps\n\n```bash\npnpm dev\n```\n\n## Self-hosting\n\nBefore self-hosting, you should [setup the environment variables](#setup-the-environment-variables).\n\n### Docker\n\nYou can use docker-compose:\n\n```sh\ndocker compose up -d\n```\n\nOr build the image and run it manually:\n\n```sh\ndocker build -t flow .\ndocker run -p 3000:3000 --env-file apps/reader/.env.local flow\n```\n\n## Contributing\n\nThere are many ways in which you can participate in this project, for example:\n\n- [Submit bugs and feature requests](https://github.com/pacexy/flow/issues/new), and help us verify as they are checked in\n- [Submit pull requests](https://github.com/pacexy/flow/pulls)\n\n## Credits\n\n- [Epub.js](https://github.com/futurepress/epub.js/)\n- [React](https://github.com/facebook/react)\n- [Next.js](https://nextjs.org/)\n- [TypeScript](https://www.typescriptlang.org)\n- [Vercel](https://vercel.com)\n- [Turborepo](https://turbo.build/repo)\n","funding_links":["https://patreon.com/pacexy","https://ko-fi.com/pacexy"],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpacexy%2Fflow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpacexy%2Fflow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpacexy%2Fflow/lists"}