https://github.com/eoic/papyrus
Cross-platform book management system.
https://github.com/eoic/papyrus
cross-platform dart django-rest-framework ebook-library ebook-manager ebook-reader flutter library-management-system offline-first postgresql python
Last synced: about 1 year ago
JSON representation
Cross-platform book management system.
- Host: GitHub
- URL: https://github.com/eoic/papyrus
- Owner: Eoic
- License: agpl-3.0
- Created: 2021-12-28T23:05:28.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-04-10T20:30:02.000Z (about 1 year ago)
- Last Synced: 2025-04-10T21:29:23.132Z (about 1 year ago)
- Topics: cross-platform, dart, django-rest-framework, ebook-library, ebook-manager, ebook-reader, flutter, library-management-system, offline-first, postgresql, python
- Language: Dart
- Homepage:
- Size: 7.89 MB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
___
A cross-platform book management system.
___
## Table of contents
- [Overview](#overview)
- [Why?](#why)
- [Key features](#key-features)
- [Getting started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Project resources](#project-resources)
- [Contributing](#contributing)
- [Contact](#contact)
## Overview
Papyrus 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/).
### Why?
Many 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.
### Key Features
* **Cross-platform**: manage physical and electronic books seamlessly across devices.
Integrated e-book viewer: customize your reading experience with various look-and-feel options.
* **Flexible management**: organize physical and e-books into shelves, categories, attach tags, create custom filters.
* **Progress tracking**: track reading time and books read, plan and create custom reading goals.
* **Storage**: easily add new books, convert and export books files, choose file storage methods.
## Getting started
### Prerequisites
- **Flutter SDK:** Ensure you have [Flutter installed](https://flutter.dev/docs/get-started/install).
- **Dart SDK:** This is included when you install Flutter.
### Installation
1. Clone the repository
```bash
git clone git@github.com:Eoic/Papyrus.git
cd Papyrus
```
2. Install dependencies
```bash
flutter pub get
```
3. Run the application
**Mobile (Android / iOS)**
Connect your device or start an emulator and run:
```bash
flutter run
```
**Web**
Run the following command to launch Papyrus in Chrome (or another supported browser):
```bash
flutter run -f chrome
```
**Desktop**
Make sure desktop support is enabled by referring to Flutter desktop setup page. Then run:
```bash
flutter run -d windows # or -d macos, -d linux
```
## Project resources
* **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.
* **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&t=2x3bT0cacWbQsPdy-1).
## Contributing
Follow the steps to submit your contributions:
1. Fork the repository.
2. Create a feature branch:
```bash
git checkout b feature/
```
3. Commit your changes:
```bash
git commit -m ""
```
4. Push to your branch:
```bash
git push origin feature/
```
5. Open a pull request.
## Contact
For any questions, feedback, or suggestions, please contact:
- **Project Maintainer:** [Karolis Strazdas](mailto:karolis.strazdas@pm.me)