-
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
Showing
4 changed files
with
11 additions
and
61 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,47 +1,10 @@ | ||
# NABD | ||
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](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 `react-native run-android` | ||
|
||
## :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 |
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
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
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