paperless-mobile/README.md

Paperless Mobile

An (almost) fully fledged mobile paperless client.

Report Bug · Request Feature

Important 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

With this app you can conveniently add, manage or simply find documents stored in your paperless server without any comproimises. This project started as a small fun side project to learn more about the Flutter framework and because existing solutions didn't fulfill my needs, but it has grown much faster with far more features than I originally anticipated.

🚀 Features

✔️ View your documents at a glance, in a compact list or a more detailed grid view
✔️ Add, delete or edit your documents
✔️ Share, download and preview PDF files
✔️ Manage and assign correspondents, document types, tags and storage paths
✔️ Scan and upload documents to paperless with preset correspondent, document type, tags and creation date
✔️ Upload existing documents from other apps via Paperless Mobile
✔️ See all new documents in a dedicated inbox
✔️ Search for documents using a wide range of filter criteria
✔️ Secure your data with biometric authentication across sessions
✔️ Support for TLS mutual authentication (client certificates)
✔️ Modern, intuitive UI built according to the Material Design 3 specification
✔️ Available in english and german language (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

1. 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:

2. Install the dependencies for paperless_api

   flutter pub get
   

3. Build generated files for paperless_api

    flutter pub run build_runner build --delete-conflicting-outputs
   

Inside the project's root folder

4. Install the dependencies for the app

   flutter packages pub get
   

5. Build generated files for the app

   flutter packages pub run build_runner build --delete-conflicting-outputs
   

6. Generate the localization files for the app

   flutter gen-l10n
   

Build release version

In order to build a release version, you have to...

1. 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.

2. 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.

3. 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

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 by astubenbord
• Czech language by svetlemodry
• Turkish language by imsakg

Roadmap

• Fully custom document scanner optimized for common white A4 documents and optimized for the use with Paperless
• Add more languages
• Support for IOS and publish to AppStore
• 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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. 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.