|
| 1 | + |
| 2 | +# React Native Phone Verification |
| 3 | + |
| 4 | +[![PayPal Donate][paypal-donate-image]][paypal-donate-url] |
| 5 | +[![Slack Status][slack-image]][slack-url] |
| 6 | +[![Standard JS Style][standard-image]][standard-url] |
| 7 | +[![MIT License][license-image]][license-url] |
| 8 | + |
| 9 | +The best React Native example for phone verification (an alternative to [Twitter Digits][twitter-digits]). This package was built for [CrocodileJS][crocodile-url]. |
| 10 | + |
| 11 | +![React Native Phone Verification][demo] |
| 12 | + |
| 13 | +## Features |
| 14 | + |
| 15 | +* :boom: Works with iOS and Android! :100: 100% Cross-platform baby :baby:! |
| 16 | +* :flags: Built-in country picker (uses [react-native-country-picker-modal][react-native-country-picker-modal])! |
| 17 | +* :wrench: Completely customizable form (uses [react-native-form][react-native-form], but you could also use [tcomb-form-native][tcomb-form-native])! |
| 18 | +* :crystal_ball: Spinner overlay (uses [react-native-loading-spinner-overlay][react-native-loading-spinner-overlay])! |
| 19 | +* :sparkles: Optional Android support for reading verification codes automatically (uses [react-native-android-sms-listener][react-native-android-sms-listener])! |
| 20 | + |
| 21 | +## Usage |
| 22 | + |
| 23 | +1. Install [React Native][react-native]: |
| 24 | + |
| 25 | + ```bash |
| 26 | + npm install -g react-native |
| 27 | + ``` |
| 28 | + |
| 29 | +2. Initialize a new project: |
| 30 | + |
| 31 | + ```bash |
| 32 | + react-native init myproject |
| 33 | + ``` |
| 34 | + |
| 35 | +3. Install dependencies: |
| 36 | + |
| 37 | + > If you're using `npm` to install packages: |
| 38 | +
|
| 39 | + ```bash |
| 40 | + npm install --save frisbee react-native-android-sms-listener niftylettuce/react-native-country-picker-modal react-native-form react-native-loading-spinner-overlay |
| 41 | + ``` |
| 42 | + |
| 43 | + > Or, if you're using `yarn` to install packages: |
| 44 | +
|
| 45 | + ```bash |
| 46 | + yarn add frisbee react-native-android-sms-listener niftylettuce/react-native-country-picker-modal react-native-form react-native-loading-spinner-overlay |
| 47 | + ``` |
| 48 | + |
| 49 | +4. See [example][example] directory for how to integrate into your codebase (you can also just clone this repo and run the example to test it out). |
| 50 | + |
| 51 | + |
| 52 | +## License |
| 53 | + |
| 54 | +All code is licensed under [MIT][license-url] |
| 55 | + |
| 56 | + |
| 57 | +[paypal-donate-image]: https://img.shields.io/badge/paypal-donate-orange.svg |
| 58 | +[paypal-donate-url]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=FE3EFQ5X9RHT6 |
| 59 | +[license-image]: http://img.shields.io/badge/license-MIT-blue.svg |
| 60 | +[license-url]: LICENSE |
| 61 | +[crocodile-url]: https://crocodilejs.com |
| 62 | +[slack-image]: http://slack.crocodilejs.com/badge.svg |
| 63 | +[slack-url]: http://slack.crocodilejs.com |
| 64 | +[standard-image]: https://img.shields.io/badge/code%20style-standard%2Bes7-brightgreen.svg |
| 65 | +[standard-url]: https://github.com/crocodilejs/eslint-config-crocodile |
| 66 | +[react-native-country-picker-modal]: https://github.com/xcarpentier/react-native-country-picker-modal |
| 67 | +[react-native]: https://facebook.github.io/react-native/ |
| 68 | +[react-native-android-sms-listener]: https://github.com/CentaurWarchief/react-native-android-sms-listener |
| 69 | +[tcomb-form-native]: https://github.com/gcanti/tcomb-form-native |
| 70 | +[react-native-form]: https://github.com/julianocomg/react-native-form |
| 71 | +[react-native-loading-spinner-overlay]: https://github.com/niftylettuce/react-native-loading-spinner-overlay |
| 72 | +[demo]: https://cdn.rawgit.com/niftylettuce/react-native-phone-verification/master/media/example.png |
| 73 | +[example]: example/index.ios.js |
| 74 | +[twitter-digits]: https://get.digits.com/ |
0 commit comments