|
1 | 1 | # OpenCV |
2 | | -[](http://standardjs.com/) |
| 2 | +OpenCV is an open source mobile app to see their cv |
3 | 3 |
|
4 | | -* Standard compliant React Native App Utilizing [Ignite](https://github.com/infinitered/ignite) |
| 4 | +[![MIT License][license-image]][license-url] [![Stars][stars-image]][stars-url] [![js-standard-style][js-standard]][js-standard-url] [![React Native][package-react-native]][react-native-url] |
5 | 5 |
|
6 | | -## :arrow_up: How to Setup |
| 6 | +## Prerequisites |
| 7 | +- Xcode or Android Studio installed and exported on your ~/.bash_profile or similar |
| 8 | +- JDK 1.8 |
| 9 | +- Node >= 12.* |
| 10 | +- react-native-cli |
7 | 11 |
|
8 | | -**Step 1:** git clone this repo: |
9 | | - |
10 | | -**Step 2:** cd to the cloned repo: |
11 | | - |
12 | | -**Step 3:** Install the Application with `yarn` or `npm i` |
13 | | - |
14 | | - |
15 | | -## :arrow_forward: How to Run App |
16 | | - |
17 | | -1. cd to the repo |
18 | | -2. Run Build for either OS |
19 | | - * for iOS |
20 | | - * run `npx react-native run-ios` |
21 | | - * for Android |
22 | | - * Run Genymotion |
23 | | - * run `npx react-native run-android` |
24 | | - |
25 | | -## :no_entry_sign: Standard Compliant |
26 | | - |
27 | | -[](https://github.com/feross/standard) |
28 | | -This project adheres to Standard. Our CI enforces this, so we suggest you enable linting to keep your project compliant during development. |
| 12 | +## Installation |
| 13 | +open terminal and change directory to your desired folder, then: |
| 14 | +``` |
| 15 | +$ git clone [email protected]:libscode/OpenCV.git YourAppName |
| 16 | +$ cd YourAppName |
| 17 | +$ yarn install |
| 18 | +$ yarn run rm-git && npm run androidx |
| 19 | +``` |
| 20 | +## License |
| 21 | +The code is available at [GitHub][home] under the [MIT license][license-url]. |
29 | 22 |
|
| 23 | +## Additional |
30 | 24 | **To Lint on Commit** |
31 | 25 |
|
32 | 26 | This is implemented using [husky](https://github.com/typicode/husky). There is no additional setup needed. |
@@ -65,3 +59,24 @@ The `.env` file is ignored by git keeping those secrets out of your repo. |
65 | 59 | 2. Add your config variables |
66 | 60 | 3. Follow instructions at [https://github.com/luggit/react-native-config#setup](https://github.com/luggit/react-native-config#setup) |
67 | 61 | 4. Done! |
| 62 | + |
| 63 | +## Contributors |
| 64 | +Suggestions and contributions are welcome via Pull Requests. |
| 65 | +<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> |
| 66 | +| [<img src="https://avatars3.githubusercontent.com/u/8052370" width="100px;"/><br /><sub><b>Rully Ardiansyah</b></sub>](https://github.com/DeVoresyah)<br />[💻](https://github.com/libscode/OpenCV/commits?author=DeVoresyah "Code") [📖](https://github.com/libscode/OpenCV/commits?author=DeVoresyah "Documentation") [💬](#question-devoresyah "Answering Questions") [👀](#review-devoresyah "Reviewed Pull Requests") [💡](#example-devoresyah "Examples") | [<img src="https://cdn.dribbble.com/users/3843915/avatars/normal/data?1563263378" width="100px;"/><br /><sub><b>Arkanpo</b></sub>](https://dribbble.com/arkanpo)<br /> [🎨](#logo-design "UI/UX Design") [💡](#concept-arkanpo "Concept") | |
| 67 | +| :---: | :---: | |
| 68 | +<!-- ALL-CONTRIBUTORS-LIST:END --> |
| 69 | + |
| 70 | +[home]: https://github.com/libscode/OpenCV |
| 71 | + |
| 72 | +[license-image]: https://img.shields.io/github/license/libscode/OpenCV.svg?style=flat |
| 73 | +[license-url]: LICENSE |
| 74 | + |
| 75 | +[stars-image]: https://img.shields.io/github/stars/libscode/OpenCV.svg?style=flat |
| 76 | +[stars-url]: https://github.com/DeVoresyah/JeptureApp/stargazers |
| 77 | + |
| 78 | +[js-standard]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat |
| 79 | +[js-standard-url]: http://standardjs.com/ |
| 80 | + |
| 81 | +[package-react-native]: https://img.shields.io/badge/react--native-0.59.9-blue.svg?style=flat |
| 82 | +[react-native-url]: https://github.com/facebook/react-native |
0 commit comments