{"id":18939978,"url":"https://github.com/eoic/papyrus","last_synced_at":"2025-04-15T19:31:03.600Z","repository":{"id":126992527,"uuid":"442605331","full_name":"Eoic/Papyrus","owner":"Eoic","description":"Cross-platform book management system.","archived":false,"fork":false,"pushed_at":"2025-04-10T20:30:02.000Z","size":8277,"stargazers_count":11,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-10T21:29:23.132Z","etag":null,"topics":["cross-platform","dart","django-rest-framework","ebook-library","ebook-manager","ebook-reader","flutter","library-management-system","offline-first","postgresql","python"],"latest_commit_sha":null,"homepage":"","language":"Dart","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/Eoic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2021-12-28T23:05:28.000Z","updated_at":"2025-04-10T20:30:05.000Z","dependencies_parsed_at":null,"dependency_job_id":"7548bce7-e479-47a3-ad27-a4f2ad792632","html_url":"https://github.com/Eoic/Papyrus","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/Eoic%2FPapyrus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Eoic%2FPapyrus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Eoic%2FPapyrus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Eoic%2FPapyrus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Eoic","download_url":"https://codeload.github.com/Eoic/Papyrus/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249138671,"owners_count":21218924,"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":["cross-platform","dart","django-rest-framework","ebook-library","ebook-manager","ebook-reader","flutter","library-management-system","offline-first","postgresql","python"],"created_at":"2024-11-08T12:19:34.647Z","updated_at":"2025-04-15T19:31:03.595Z","avatar_url":"https://github.com/Eoic.png","language":"Dart","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca href=\"https://karolis-1.gitbook.io/papyrus-project/\"\u003e\u003cimg src=\"https://img.shields.io/badge/GitBook-Specification-%232F2F2F.svg?logo=gitbook\u0026logoColor=white\u0026labelColor=%23307f98\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://discord.gg/XjBV8uPW\"\u003e\u003cimg src=\"https://img.shields.io/badge/Discord-Chat-%232F2F2F.svg?logo=discord\u0026logoColor=white\u0026labelColor=%235865F5\"/\u003e\u003c/a\u003e\n___\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg width=\"300\" src=\"/public/img/logo-dark.svg#gh-dark-mode-only\" alt=\"papyrus\"\u003e\n  \u003cimg width=\"300\" src=\"/public/img/logo-light.svg#gh-light-mode-only\" alt=\"papyrus\"\u003e\n  \u003cp align=\"center\"\u003e A cross-platform book management system. \u003c/p\u003e\n\u003c/div\u003e\n\n___\n\n## Table of contents\n- [Overview](#overview)\n  - [Why?](#why)\n  - [Key features](#key-features)\n- [Getting started](#getting-started)\n  - [Prerequisites](#prerequisites)\n  - [Installation](#installation)\n- [Project resources](#project-resources)\n- [Contributing](#contributing)\n- [Contact](#contact)\n\n## Overview\nPapyrus aims to provide a versatile, easy-to-use system that makes reading comfortable and fun. It's designed to be accessible on a wide range of platforms, including Android, iOS, Web, and Desktop, featuring an intuitive, modern UI with various customization options. You can find more information in the specification [here](https://karolis-1.gitbook.io/papyrus-project/).\n\n### Why?\nMany solutions offer some reading functionalities but fall short on some essential features or user experience. Papyrus aims to deliver a comprehensive solution that balances functionality with good user experience, covering all your reading needs in one application.\n\n### Key Features\n* **Cross-platform**: manage physical and electronic books seamlessly across devices.\n Integrated e-book viewer: customize your reading experience with various look-and-feel options.\n* **Flexible management**: organize physical and e-books into shelves, categories, attach tags, create custom filters.\n* **Progress tracking**: track reading time and books read, plan and create custom reading goals.\n* **Storage**: easily add new books, convert and export books files, choose file storage methods.\n\n## Getting started\n### Prerequisites\n- **Flutter SDK:** Ensure you have [Flutter installed](https://flutter.dev/docs/get-started/install).  \n- **Dart SDK:** This is included when you install Flutter.\n\n### Installation\n1. Clone the repository\n ```bash\n git clone git@github.com:Eoic/Papyrus.git\n cd Papyrus\n ```\n2. Install dependencies\n ```bash\n flutter pub get\n ```\n3. Run the application\n\n   **Mobile (Android / iOS)**\n   Connect your device or start an emulator and run:\n   ```bash\n   flutter run\n   ```\n\n   **Web**\n   Run the following command to launch Papyrus in Chrome (or another supported browser):\n   ```bash\n   flutter run -f chrome\n   ```\n\n   **Desktop**\n   Make sure desktop support is enabled by referring to Flutter desktop setup page. Then run:\n   ```bash\n   flutter run -d windows  # or -d macos, -d linux\n   ```\n\n## Project resources\n* **API Specification**: the backend REST API is documented using OpenAPI specification. You can find the current OpenAPI spec in the [design/api](./design/api/) directory.\n* **Design Prototype**: the UI/UX design is created in Figma, and you can find it [here](https://www.figma.com/design/nnL41KQvrlVU4ecF8mtB07/Papyrus?node-id=0-1\u0026t=2x3bT0cacWbQsPdy-1).\n\n## Contributing\nFollow the steps to submit your contributions:\n1. Fork the repository.\n2. Create a feature branch:\n   ```bash\n   git checkout b feature/\u003cyour-feature\u003e\n   ```\n3. Commit your changes:\n   ```bash\n   git commit -m \"\u003cdescription of your changes\u003e\"\n   ```\n4. Push to your branch:\n   ```bash\n   git push origin feature/\u003cyour-feature\u003e\n   ```\n5. Open a pull request.\n\n## Contact\nFor any questions, feedback, or suggestions, please contact:\n- **Project Maintainer:** [Karolis Strazdas](mailto:karolis.strazdas@pm.me)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feoic%2Fpapyrus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feoic%2Fpapyrus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feoic%2Fpapyrus/lists"}