Bill Scanner is an Android application that allows users to capture images of their bills and extract text from them using Optical Character Recognition (OCR) technology.
- Capture bills using the device camera
- Detect and recognize text from captured images
- Display extracted text for user review
- Save and manage scanned bills
- Android SDK: Native Android development
- CameraX: For camera functionality
- ML Kit: For text recognition
- Android Studio 4.0 or higher
- Android device or emulator running Android 5.0 (Lollipop) or higher
-
Clone the repository:
git clone https://github.com/thanhtunguet/BillScanner.Android.git cd BillScanner.Android
-
Open the project in Android Studio.
-
Build the project:
- Select
Build > Make Project
from the menu. - Ensure there are no build errors.
- Select
-
Run the app:
- Connect an Android device or start an emulator.
- Select
Run > Run 'app'
.
- Launch the Bill Scanner app on your Android device.
- Point the camera at a bill and press the capture button.
- The app will process the image and display the extracted text.
- Review the text and save the scan if desired.
This project includes a GitHub Actions workflow for continuous integration. The workflow:
- Builds the project on every push and pull request to the
main
branch. - Publishes the APK as an artifact.
The workflow is defined in .github/workflows/build.yml
.
We welcome contributions! Please follow these steps to contribute:
- Fork the repository.
- Create a new branch:
git checkout -b feature/my-feature
. - Make your changes and commit them:
git commit -m 'Add some feature'
. - Push to the branch:
git push origin feature/my-feature
. - Open a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.
For questions or suggestions, please open an issue or contact [email protected].