https://github.com/agoldis/react-native-mlkit-ocr

Google on-device MLKit Text Recognition for React Native
https://github.com/agoldis/react-native-mlkit-ocr

mlkit ocr react-native text-recognition

Last synced: 4 days ago
JSON representation

Google on-device MLKit Text Recognition for React Native

• Host: GitHub
• URL: https://github.com/agoldis/react-native-mlkit-ocr
• Owner: agoldis
• License: mit
• Created: 2020-12-05T10:04:27.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-11-20T19:35:48.000Z (about 1 year ago)
• Last Synced: 2024-12-28T07:15:07.774Z (11 days ago)
• Topics: mlkit, ocr, react-native, text-recognition
• Language: Java
• Homepage:
• Size: 858 KB
• Stars: 181
• Watchers: 7
• Forks: 44
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# react-native-mlkit-ocr



    Google on-device MLKit text recognition for React Native





  



## Installation

```sh

npm install react-native-mlkit-ocr

```

## Post-install Steps

### iOS

Run

```js

cd ios && pod install

```

## Usage

```js

import MlkitOcr from 'react-native-mlkit-ocr';

// ...

const resultFromUri = await MlkitOcr.detectFromUri(uri);

const resultFromFile = await MlkitOcr.detectFromFile(path);

```

## Example

To get started with the project, run `yarn bootstrap` in the root directory to install the required dependencies for each package:

```sh

yarn bootstrap

```

To start the packager:

```sh

yarn example start

```

To run the example app on Android:

```sh

yarn example android

```

To run the example app on iOS:

```sh

yarn example ios

```

## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

## License

MIT