Giter Club home page Giter Club logo

billscanner.android's Introduction

Bill Scanner App

Build Status

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:

    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

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 file for details.

Contact

For questions or suggestions, please open an issue or contact [email protected].

billscanner.android's People

Contributors

thanhtunguet avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.