astubenbord/paperless-mobile
An (almost) fully fledged mobile paperless client.
go to github downloadImportant Notice
This project is under very active development. Breaking changes are expected and therefore a clean install is recommended for each update!
About The Project
Paperless Mobile brings paperless-ngx to your smartphone without any compromises. While you can use paperless-ngx from a mobile browser, managing your documents this way is often a tedious and slow process. The app integrates a custom scanner, biometric authentication and many more conveniences to help you make the transition from a paper-based to a fully digital office experience.
:rocket: Highlights
:heavy_check_mark: View your documents at a glance
:heavy_check_mark: Add, delete or edit documents
:heavy_check_mark: Share, download and preview files
:heavy_check_mark: Manage and assign labels
:heavy_check_mark: Scan and upload documents to paperless
:heavy_check_mark: Upload existing documents from other apps via Paperless Mobile
:heavy_check_mark: Easily process and manage new documents in the dedicated inbox
:heavy_check_mark: Search for documents using a wide range of filter criteria
:heavy_check_mark: Secure your data with a biometric factor
:heavy_check_mark: Support for TLS mutual authentication (client certificates)
:heavy_check_mark: Modern, intuitive UI built according to the Material Design 3 specification
:heavy_check_mark: Available in English, German, Polish, French, Catalan, Czech and Turkish language with more to come
Built With
Getting Started
To get a local copy up and running follow these simple steps.
Prerequisites
- Install an IDE of your choice (e.g. VSCode with the Dart/Flutter extensions)
- Install the flutter SDK (https://docs.flutter.dev/get-started/install) or use the flutter git submodule pinned in this project by running
git submodule update --init
inside the project root directory.
Install dependencies and generate files
- First, clone the repository:
git clone https://github.com/astubenbord/paperless-mobile.git
You can now run the scripts/install_dependencies.sh
script at the root of the project, which will automatically install dependencies and generate files for both the app and local packages.
If you want to manually install dependencies and build generated files, you can also run the following commands:
Inside the packages/paperless_api/
folder:
- Install the dependencies for
paperless_api
flutter pub get
- Build generated files for
paperless_api
flutter pub run build_runner build --delete-conflicting-outputs
Inside the project’s root folder
- Install the dependencies for the app
flutter packages pub get
- Build generated files for the app
flutter packages pub run build_runner build --delete-conflicting-outputs
- Generate the localization files for the app
flutter gen-l10n
Build release version
In order to build a release version, you have to…
- Exchange the signing configuration in android/app/build.gradle from
buildTypes {
release {
signingConfig signingConfigs.release
}
}
to
buildTypes {
release {
signingConfig signingConfigs.debug
}
}
or use your own signing configuration as described in https://docs.flutter.dev/deployment/android#signing-the-app and leave the build.gradle
as is.
- Build the app with release profile (here for android):
flutter build apk
The --release flag is implicit for the build command. You can also run this command with --split-per-abi, which will generate three separate (smaller) binaries.
- Install the app to your device (when omitting the
--split-per-abi
flag)
flutter install
or when you built with --split-per-abi
flutter install --use-application-binary=build/pp/outputs/flutter-apk/<apk_file_name>.apk
Languages and Translations ![Crowdin](https://badges.crowdin.net/paperless-mobile/localized.svg)
If you want to contribute by translating a language, feel free to join the Crowdin project!
Thanks to the following contributors for providing translations:
- German and English language translated by astubenbord
- Czech language translated by svetlemodry
- Turkish language translated by imsakg
- Polish language translated by losiu97
- French language translated by JigSawFr, SpicyWasab and nathanaelhoun
- Catalan language translated by rubenix
Roadmap
- [ ] Fully custom document scanner optimized for common white A4 documents and optimized for the use with Paperless
- [ ] Add more languages
- [x] Support for IOS and publish to AppStore
- [x] Automatic releases and CI/CD with fastlane
- [ ] Templates for recurring scans (e.g. monthly payrolls with same title, dates at end of month, fixed correspondent and document type)
See the open issues for a full list of issues and open feature requests for requested features.
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
All bug reports or feature requests are welcome, even if you can’t contribute code!
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag “enhancement”.
Don’t forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'feat: Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the GNU General Public License v3.0. See LICENSE.txt
for more information.
Donations
I do this in my free time, so if you like the project, consider buying me a coffee! Any donation is much appreciated :^)
Contributors
Made with contrib.rocks.
Troubleshooting
Suggestions are not selectable in any of the label form fields
This is a known issue and it has to do with accessibility features of Android. Password managers such as Bitwarden often caused this issue. Luckily, this can be resolved by turning off the accessibility features in these apps. This could also be observed with apps that are allowed to display over other apps, such as emulations of the dynamic island on android.
I cannot log in since the update to paperless-ngx 1.14.0 (and above).
The app has to somehow get information about it’s user from the paperless API. Therefore, the Users -> View
and the UISettings -> View
permissions are required for each user trying to log into the app. Otherwise, the app has no way of obtaining your user id and other information required for the usage of most features.
![](/images/banner-woo.jpg)
excellent projects related to astubenbord/paperless-mobile recommend downloading
AppFlowy
47859
AppFlowy is an open-source alternative to Notion. You are in charge of your data and customizations. Built with Flutter and Rust.
localsend
33797
An open-source cross-platform alternative to AirDrop
spotube
23772
🎧 Open source Spotify client that doesn't require Premium nor uses Electron! Available for both desktop & mobile!
revanced-manager
15035
💊 Application to use ReVanced on Android
gsy_github_app_flutter
14559
Flutter 超完整的开源项目,功能丰富,适合学习和日常使用。GSYGithubApp系列的优势:我们目前已经拥有Flutter、Weex、ReactNative、kotlin 四个版本。 功能齐全,项目框架内技术涉及面广,完成度高,持续维护,配套文章,适合全面学习,对比参考。跨平台的开源Github客户端App,更好的体验,更丰富的功能,旨在更好的日常管理和维护个人Github,提供更好更方便的驾车体验Σ( ̄。 ̄ノ)ノ。同款Weex版本 : https://github.com/CarGuo/GSYGithubAppWeex 、同款React Native版本 : https://github.com/CarGuo/GSYGithubApp 、原生 kotlin 版本 https://github.com/CarGuo/GSYGithubAppKotlin
dio
12249
A powerful HTTP client for Dart and Flutter, which supports global settings, Interceptors, FormData, aborting and canceling a request, files uploading and downloading, requests timeout, custom adapters, etc.
gopeed
11832
A modern download manager that supports all platforms. Built with Golang and Flutter.
bloc
11441
A predictable state management library that helps implement the BLoC design pattern
getx
9899
Open screens/snackbars/dialogs/bottomSheets without context, manage states and inject dependencies easily with Get.
flame
8846
A Flutter based game engine.
flutter_deer
7595
🦌 Flutter 练习项目(包括集成测试、可访问性测试)。内含完整UI设计图,更贴近真实项目的练习。Flutter practice project (including integration testing and accessibility testing). Contains complete UI design drawings for a more realistic practice project.
fish-redux
7343
An assembled flutter application framework.
ente
6686
Fully open source, End to End Encrypted alternative to Google Photos and Apple Photos
fl_chart
6451
FL Chart is a highly customizable Flutter chart library that supports Line Chart, Bar Chart, Pie Chart, Scatter Chart, and Radar Chart.
pixez-flutter
6360
一个支持免代理直连及查看动图的第三方Pixiv flutter客户端
Flutter-Responsive-Admin-Panel-or-Dashboard
6355
Responsive Admin Panel or Dashboard using Flutter
aidea
6021
AIdea 是一款支持 GPT 以及国产大语言模型通义千问、文心一言等,支持 Stable Diffusion 文生图、图生图、 SDXL1.0、超分辨率、图片上色的全能型 APP。
riverpod
5828
A reactive caching and data-binding framework. Riverpod makes working with asynchronous code a breeze.
pikapika
5463
美观易用且无广告的漫画和游戏客户端,同时支持MacOS,Windows,Android,iOS。
provider
5029
InheritedWidgets, but simple