8.6 KiB
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 with preset correspondent, document type, tags and creation date
✔️ 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 the Flutter SDK (https://docs.flutter.dev/get-started/install)
- Install an IDE of your choice (e.g. VSCode with the Dart/Flutter extensions)
Install dependencies and generate files
- Clone the repo
git clone https://github.com/astubenbord/paperless-mobile.git - Install the dependencies
flutter pub get - Build generated files (e.g. for injectable library)
flutter packages pub run build_runner build --delete-conflicting-outputs - Generate the localization files
flutter pub run intl_utils:generate
Roadmap
- Add download functionality (implemented, but flutter cannot download to useful directories except app directory)
- Add document share support
- 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 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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m '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.
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
