Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thanhtunguet/billscanner.android
https://github.com/thanhtunguet/billscanner.android
Last synced: 23 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/thanhtunguet/billscanner.android
- Owner: thanhtunguet
- License: mit
- Created: 2024-05-19T03:37:48.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-05-19T03:49:27.000Z (7 months ago)
- Last Synced: 2024-05-19T04:29:04.102Z (7 months ago)
- Language: Kotlin
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bill Scanner App
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.
## Features
- Capture bills using the device camera
- Detect and recognize text from captured images
- Display extracted text for user review
- Save and manage scanned bills
## Technologies Used
- **Android SDK**: Native Android development
- **CameraX**: For camera functionality
- **ML Kit**: For text recognition
## Getting Started
### Prerequisites
- Android Studio 4.0 or higher
- Android device or emulator running Android 5.0 (Lollipop) or higher
### Installation
1. Clone the repository:
```bash
git clone https://github.com/thanhtunguet/BillScanner.Android.git
cd BillScanner.Android
```
2. Open the project in Android Studio.
3. Build the project:
- Select `Build > Make Project` from the menu.
- Ensure there are no build errors.
4. Run the app:
- Connect an Android device or start an emulator.
- Select `Run > Run 'app'`.
## Usage
1. Launch the Bill Scanner app on your Android device.
2. Point the camera at a bill and press the capture button.
3. The app will process the image and display the extracted text.
4. Review the text and save the scan if desired.
## CI/CD with GitHub Actions
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.
### Workflow Configuration
The workflow is defined in `.github/workflows/build.yml`.
### Build Status
## Contributing
We welcome contributions! Please follow these steps to contribute:
1. Fork the repository.
2. Create a new branch: `git checkout -b feature/my-feature`.
3. Make your changes and commit them: `git commit -m 'Add some feature'`.
4. Push to the branch: `git push origin feature/my-feature`.
5. Open a pull request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contact
For questions or suggestions, please open an issue or contact [[email protected]](mailto:[email protected]).