-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
587e49e
commit 45e41e1
Showing
1 changed file
with
8 additions
and
63 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,65 +1,10 @@ | ||
| # NABD | ||
| [](http://standardjs.com/) | ||
| # Nabd | ||
|
|
||
| ## :arrow_up: How to Setup | ||
| ## - Installation Instructions | ||
|
|
||
| **Step 1:** git clone this repo: | ||
|
|
||
| **Step 2:** cd to the cloned repo: | ||
|
|
||
| **Step 3:** Install the Application with `yarn` or `npm i` | ||
|
|
||
|
|
||
| ## :arrow_forward: How to Run App | ||
|
|
||
| 1. cd to the repo | ||
| 2. Run Build for either OS | ||
| * for iOS | ||
| * run `react-native run-ios` | ||
| * for Android | ||
| * Run Genymotion | ||
| * run `react-native run-android` | ||
|
|
||
| ## :no_entry_sign: Standard Compliant | ||
|
|
||
| [](https://github.com/feross/standard) | ||
| This project adheres to Standard. Our CI enforces this, so we suggest you enable linting to keep your project compliant during development. | ||
|
|
||
| **To Lint on Commit** | ||
|
|
||
| This is implemented using [husky](https://github.com/typicode/husky). There is no additional setup needed. | ||
|
|
||
| **Bypass Lint** | ||
|
|
||
| If you have to bypass lint for a special commit that you will come back and clean (pushing something to a branch etc.) then you can bypass git hooks with adding `--no-verify` to your commit command. | ||
|
|
||
| **Understanding Linting Errors** | ||
|
|
||
| The linting rules are from JS Standard and React-Standard. [Regular JS errors can be found with descriptions here](http://eslint.org/docs/rules/), while [React errors and descriptions can be found here](https://github.com/yannickcr/eslint-plugin-react). | ||
|
|
||
| ## :closed_lock_with_key: Secrets | ||
|
|
||
| This project uses [react-native-config](https://github.com/luggit/react-native-config) to expose config variables to your javascript code in React Native. You can store API keys | ||
| and other sensitive information in a `.env` file: | ||
|
|
||
| ``` | ||
| API_URL=https://myapi.com | ||
| GOOGLE_MAPS_API_KEY=abcdefgh | ||
| ``` | ||
|
|
||
| and access them from React Native like so: | ||
|
|
||
| ``` | ||
| import Secrets from 'react-native-config' | ||
| Secrets.API_URL // 'https://myapi.com' | ||
| Secrets.GOOGLE_MAPS_API_KEY // 'abcdefgh' | ||
| ``` | ||
|
|
||
| The `.env` file is ignored by git keeping those secrets out of your repo. | ||
|
|
||
| ### Get started: | ||
| 1. Copy .env.example to .env | ||
| 2. Add your config variables | ||
| 3. Follow instructions at [https://github.com/luggit/react-native-config#setup](https://github.com/luggit/react-native-config#setup) | ||
| 4. Done! | ||
| - Setup React Native environment using this [link][https://facebook.github.io/react-native/docs/getting-started], make sure that you select 'React Native CLI Quickstart' | ||
| - Prepare your android device/emulator using these [instructions][https://facebook.github.io/react-native/docs/getting-started#preparing-the-android-device] | ||
| - In the project directory: | ||
| - Run `yarn` to install required node modules | ||
| - Run `yarn start` to start Metro Bundler | ||
| - Run `yarn android` in a different terminal to install app on device/emulator in debugging mode |