Skip to content
This repository was archived by the owner on Aug 10, 2023. It is now read-only.

Commit 3a4aa57

Browse files
author
Reinaldo Haynes
committed
README update. Requirements & Contribute
1 parent 529a89d commit 3a4aa57

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ React Web Native App
33

44
The goal of this build is to create a react web and native app using a shared codebase while keeping the integrity of the `create-react-app` and `react-native` build structure.
55

6-
If you find any issues or improvements needed, feel free to submit your improvements!
7-
86
### Quick Start
97

108
1. Clone this repo.
@@ -15,11 +13,19 @@ If you find any issues or improvements needed, feel free to submit your improvem
1513

1614
4. Code the greatest app of all time.
1715

16+
### Requirements
17+
18+
This is a `node` based build app so having node installed is an obvious requirement!
19+
20+
`react-native` requires you to have the proper emulators installed for your targeted operating system. Check out the [React Native docs at Facebook](https://facebook.github.io/react-native/docs/getting-started.html) to get the install instructions. Make sure to use the instructions under the "Building Projects with Native Code" tab.
21+
22+
(Optional) `npm` is installed with node but I recommend `yarn` package management. Instruction to install Yarn [can be found here](https://yarnpkg.com/en/docs/install).
23+
1824
### Additional Options
1925

2026
Commands can be executed with `yarn <options>` or `npm run <options>`
2127

22-
| options | Description |
28+
| Options | Description |
2329
| --------- | ----------- |
2430
| install | Install dependencies and (re)build `/ios` & `/android` directories. |
2531
| test | Run tests in `/__tests__` directory. |
@@ -43,3 +49,9 @@ Commands can be executed with `yarn <options>` or `npm run <options>`
4349
| android:build | Build with a "Release" configuration. |
4450
| android:signkey | Generate keystore android |
4551
| android:signer | To sign app-release-unsigned.apk with random keystore |
52+
53+
### Contribute
54+
55+
Please...if you find any issues or improvements needed, feel free to submit your improvements!
56+
57+
Sharing is caring! 😇

0 commit comments

Comments
 (0)