REAMDE.md
OpenScan
An open source app that enables users to scan hardcopies of documents or notes and convert it to a PDF file. No ads. No data collection. We respect your privacy.
(Build instructions present at the bottom of the file)
About this app
Our open source document scanner app will enable you to scan anything (official documents, notes, photos, business cards, etc.) and convert it into a PDF file and share it via any messaging app that allows it.
Why use this app? Sometimes, you require to scan several documents and share them in this fast-paced professional world. Maybe, you want to scan and store your receipts and billing information for filing taxes. In this day and age, we look for not only ease of use in technology, but also apps which respect our data privacy and apps which doesn't force ads on our screen every other second.
We bring you OpenScan, an app which respects your privacy coupled with comprehensive and beautiful user interface and a flawless user experience.
We differentiate our self from the rest of the apps in the market by:
- Open Sourcing our app
- Respecting your data privacy
KEY FEATURES
- Scan your documents, notes, business cards.
- Simple and powerful cropping features.
- Share as PDF/JPGs.
WORK PRODUCTIVITY:
- Increase your office/work productivity by scanning and saving your documents or notes quickly and share them with anyone.
- Capture your ideas or flowcharts that you jot down hurriedly and upload them to your choice of cloud storage instantly.
- Never forget anyone's contact information by scanning the business cards and storing them.
- Scan printed documents and save them to be reviewed later or send them to your contacts to review it.
- Never worry when it comes to receipts anymore. Just scan the receipts and save them to your device and share them whenever necessary.
EDUCATIONAL PRODUCTIVITY
- Scan all your handwritten notes and share them instantly to your friends during stressful exam times.
- Never miss another lecture notes. All documents are timestamped, so just look up the date or time of the lecture to quickly bring up the lecture notes.
- Take pictures of the whiteboards or the blackboards for future reference and save those as PDFs.
- Upload your class notes to your choice of cloud storage instantly.
BUILD INSTRUCTIONS
Set up flutter on your local machine Official Flutter Docs
Clone this repo on your local machine:
git clone https://github.com/Ethereal-Developers-Inc/OpenScan.git
Using Android Studio:
Set up your editor of choice. Official Flutter Docs for setting up editor
- Android Studio
- Open the project in Android Studio.
- Make sure that you have your cursor has focused on lib/main.dart (or any other dart file) i.e. just open one of the dart files and click on the (dart) file once.
- Click on Build > Flutter > Build APK in the menubar at the top of Android Studio.
- Once the build finshes successfully, in the project folder, go to build > app > outputs > apk > release > app-release.apk
- This will be your generated apk file which you can install on your phone.
Using terminal:
- Using the terminal or cmd
- Make sure you are in the project directory where the pubspec.yaml is present and open your terminal or cmd.
- Run
flutter build apk - Once the build finshes successfully, in the project folder, go to build > app > outputs > apk > release > app-release.apk
- This will be your generated apk file which you can install on your phone.
SCREENSHOTS
