|
1 | 1 | # React Native Typescript Boilerplate |
2 | 2 |
|
3 | | -  |
| 3 | +  [](./CONTRIBUTING.md) |
4 | 4 |
|
5 | 5 | ### An opinionated [React Native](https://facebook.github.io/react-native/docs/getting-started) Starter Kit with [React Native Navigation](https://github.com/wix/react-native-navigation) + [Redux](https://github.com/reactjs/redux) + [TSLint](https://github.com/airbnb/javascript) to build iOS / Android apps using [TypeScript](https://github.com/Microsoft/TypeScript-React-Native-Starter) |
6 | 6 |
|
7 | 7 | The project has been setup based off [RN Getting Started](https://facebook.github.io/react-native/docs/getting-started) and instructions from [Microsoft's Github TypeScript React Native Starter](https://github.com/Microsoft/TypeScript-React-Native-Starter) repo. |
8 | 8 |
|
9 | 9 | This repo supports the latest version of React Native (v0.57.8+) supported by RNN (at the time of writing). |
10 | 10 |
|
| 11 | +**UPDATE** (8th March '19): RNN upgraded to v2.13.1 | RN to 0.58.6 | React to 16.8.4 |
| 12 | + |
11 | 13 | ### Who is this for? |
12 | 14 |
|
13 | | -Someone looking to jumpstart building apps using RN and loves TS. The base setup has been taken care of, just `npm install` and get going. |
| 15 | +Someone looking to jumpstart building apps using RN and prefers TS. The base setup has been taken care of, just `yarn install` and get going from respective IDEs. |
14 | 16 |
|
15 | 17 | You might also want to [rename](https://medium.com/the-react-native-log/how-to-rename-a-react-native-app-dafd92161c35) the app for your own use. |
16 | 18 |
|
17 | | -_Disclaimer_: |
18 | | -This is an **opinionated** approach to building apps with RN. The project structure is inspired by multiple production apps built by the contributors. |
| 19 | +> _Disclaimer_: This is an **opinionated** approach to building apps with RN. The project structure is inspired by multiple production apps built by the contributors. |
19 | 20 |
|
20 | 21 | The project uses and encourages to use industry best practices / tools / libraries like RNN, redux, tslint, separation of concern and structure to build a maintainable app. |
21 | 22 |
|
@@ -102,19 +103,13 @@ Launch application from XCode |
102 | 103 |
|
103 | 104 | ###### Android |
104 | 105 |
|
105 | | -For android, you will need to first create the bundle: |
106 | | - |
107 | | -``` |
108 | | -react-native bundle --platform ios --entry-file index.js --bundle-output ./ios/main.jsbundle --assets-dest ./ --dev false |
109 | | -``` |
110 | | - |
111 | | -then run the Metro Bundler from the terminal |
| 106 | +For android, run the Metro Bundler from the terminal |
112 | 107 |
|
113 | 108 | ``` |
114 | 109 | npm run start |
115 | 110 | ``` |
116 | 111 |
|
117 | | -and the launch from IDE. |
| 112 | +and then launch from IDE. |
118 | 113 |
|
119 | 114 | #### Lint |
120 | 115 |
|
@@ -172,6 +167,7 @@ Please check out [Contributing](https://github.com/AmitM30/react-native-typescri |
172 | 167 | #### Authors |
173 | 168 |
|
174 | 169 | - [**Anurag Chutani**](https://github.com/a7urag) - _Android Setup_ |
| 170 | +- [**Brian Varley**](https://github.com/BrianJVarley) - _Windows Setup_ |
175 | 171 |
|
176 | 172 | See also the list of [contributors](https://github.com/AmitM30/react-native-typescript-boilerplate/contributors) who participated in this project. |
177 | 173 |
|
|
0 commit comments