+
+
+ 
+
+
+
+
+
+## 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.
+
+
+### :rocket: Features
+:heavy_check_mark: **View** your documents at a glance, in a compact list or a more detailed grid view
+
+
+Paperless Mobile
+ +
+ An (almost) fully fledged mobile paperless client.
+
+
+
+ Report Bug
+ ·
+ Request Feature
+
+:heavy_check_mark: **Add**, **delete**, **edit**, ~**download**~ or **preview** your documents
+:heavy_check_mark: **Manage** and assign correspondents, document types, tags and storage paths
+:heavy_check_mark: **Scan** and upload documents with preset correspondent, document type, tags and creation date
+:heavy_check_mark: **Search** for documents using a wide range of filter criteria
+:heavy_check_mark: **Secure** your data with **biometric authentication** across sessions
+: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 and german language (more to come!) + + +### Built With + +[![Flutter][Flutter]][Flutter-url] + + + +## Getting Started + +To get a local copy up and running follow these simple steps. + +### Prerequisites + +* Install the Flutter SDK (https://docs.flutter.dev/get-started/install) +* Install an IDE of your choice (e.g. VSCode with the Dart/Flutter extensions) + +### Installation + +1. Clone the repo + ```sh + git clone https://github.com/astubenbord/paperless-mobile.git + ``` +2. Install the dependencies (should be done automatically by your IDE) and generate localization files + ```sh + flutter pub get + ``` +3. Build generated files (e.g. for injectable library) + ```sh + flutter packages pub run build_runner build --delete-conflicting-outputs + ``` + + +## Roadmap +- [ ] Add download functionality (implemented, but flutter cannot download to useful directories except app directory) +- [ ] Improvements to UX (e.g. form fields show clear button while empty) +- [ ] Add more languages +- [ ] Support for IOS +- [ ] 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) +- [ ] Custom document scanner optimized for common white A4 documents (currently using edge_detection, which is okay but not optimal for this use case) +- [ ] Support multiple instances (low prio) + +See the [open issues](https://github.com/astubenbord/paperless-mobile/issues) for a full list of proposed features (and known issues). + + +## 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. + + + +## Screenshots +Here are some impressions from the app! + +#### Login Page +
+
+#### Documents Overview (List)
+
+
+#### Documents Overview (Grid)
+
+
+#### Document Filter/Search (More filters below!)
+
+
+#### Document Details
+
+
+#### Edit Document
+
+
+#### Scan
+
+
+#### Upload
+
+
+
+
+[contributors-shield]: https://img.shields.io/github/contributors/astubenbord/paperless-mobile.svg?style=for-the-badge
+[contributors-url]: https://github.com/astubenbord/paperless-mobile/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/astubenbord/paperless-mobile.svg?style=for-the-badge
+[forks-url]: https://github.com/astubenbord/paperless-mobile/network/members
+[stars-shield]: https://img.shields.io/github/stars/astubenbord/paperless-mobile.svg?style=for-the-badge
+[stars-url]: https://github.com/astubenbord/paperless-mobile/stargazers
+[issues-shield]: https://img.shields.io/github/issues/astubenbord/paperless-mobile.svg?style=for-the-badge
+[issues-url]: https://github.com/astubenbord/paperless-mobile/issues
+[license-shield]: https://img.shields.io/github/license/astubenbord/paperless-mobile.svg?style=for-the-badge
+[license-url]: https://github.com/astubenbord/paperless-mobile/blob/main/LICENSE
+[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
+[linkedin-url]: https://linkedin.com/in/linkedin_username
+[product-screenshot]: images/screenshot.png
+[Flutter]: https://img.shields.io/badge/Flutter-02569B?style=for-the-badge&logo=flutter&logoColor=white
+[Flutter-url]: https://flutter.dev
+
diff --git a/analysis_options.yaml b/analysis_options.yaml
new file mode 100644
index 00000000..61b6c4de
--- /dev/null
+++ b/analysis_options.yaml
@@ -0,0 +1,29 @@
+# This file configures the analyzer, which statically analyzes Dart code to
+# check for errors, warnings, and lints.
+#
+# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
+# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
+# invoked from the command line by running `flutter analyze`.
+
+# The following line activates a set of recommended lints for Flutter apps,
+# packages, and plugins designed to encourage good coding practices.
+include: package:flutter_lints/flutter.yaml
+
+linter:
+ # The lint rules applied to this project can be customized in the
+ # section below to disable rules from the `package:flutter_lints/flutter.yaml`
+ # included above or to enable additional rules. A list of all available lints
+ # and their documentation is published at
+ # https://dart-lang.github.io/linter/lints/index.html.
+ #
+ # Instead of disabling a lint rule for the entire project in the
+ # section below, it can also be suppressed for a single line of code
+ # or a specific dart file by using the `// ignore: name_of_lint` and
+ # `// ignore_for_file: name_of_lint` syntax on the line or in the file
+ # producing the lint.
+ rules:
+ # avoid_print: false # Uncomment to disable the `avoid_print` rule
+ # prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule
+
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options
diff --git a/android/.gitignore b/android/.gitignore
new file mode 100644
index 00000000..6f568019
--- /dev/null
+++ b/android/.gitignore
@@ -0,0 +1,13 @@
+gradle-wrapper.jar
+/.gradle
+/captures/
+/gradlew
+/gradlew.bat
+/local.properties
+GeneratedPluginRegistrant.java
+
+# Remember to never publicly share your keystore.
+# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app
+key.properties
+**/*.keystore
+**/*.jks
diff --git a/android/app/build.gradle b/android/app/build.gradle
new file mode 100644
index 00000000..a3396284
--- /dev/null
+++ b/android/app/build.gradle
@@ -0,0 +1,68 @@
+def localProperties = new Properties()
+def localPropertiesFile = rootProject.file('local.properties')
+if (localPropertiesFile.exists()) {
+ localPropertiesFile.withReader('UTF-8') { reader ->
+ localProperties.load(reader)
+ }
+}
+
+def flutterRoot = localProperties.getProperty('flutter.sdk')
+if (flutterRoot == null) {
+ throw new GradleException("Flutter SDK not found. Define location with flutter.sdk in the local.properties file.")
+}
+
+def flutterVersionCode = localProperties.getProperty('flutter.versionCode')
+if (flutterVersionCode == null) {
+ flutterVersionCode = '1'
+}
+
+def flutterVersionName = localProperties.getProperty('flutter.versionName')
+if (flutterVersionName == null) {
+ flutterVersionName = '1.0'
+}
+
+apply plugin: 'com.android.application'
+apply plugin: 'kotlin-android'
+apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
+
+android {
+ compileSdkVersion 31
+
+ compileOptions {
+ sourceCompatibility JavaVersion.VERSION_1_8
+ targetCompatibility JavaVersion.VERSION_1_8
+ }
+
+ kotlinOptions {
+ jvmTarget = '1.8'
+ }
+
+ sourceSets {
+ main.java.srcDirs += 'src/main/kotlin'
+ }
+
+ defaultConfig {
+ // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
+ applicationId "de.antonjstu.flutter_paperless_mobile"
+ minSdkVersion 21
+ targetSdkVersion flutter.targetSdkVersion
+ versionCode flutterVersionCode.toInteger()
+ versionName flutterVersionName
+ }
+
+ buildTypes {
+ release {
+ // TODO: Add your own signing config for the release build.
+ // Signing with the debug keys for now, so `flutter run --release` works.
+ signingConfig signingConfigs.debug
+ }
+ }
+}
+
+flutter {
+ source '../..'
+}
+
+dependencies {
+ implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
+}
diff --git a/android/app/src/debug/AndroidManifest.xml b/android/app/src/debug/AndroidManifest.xml
new file mode 100644
index 00000000..12e47ca0
--- /dev/null
+++ b/android/app/src/debug/AndroidManifest.xml
@@ -0,0 +1,7 @@
+