Skip to content

Commit 9ad0cc8

Browse files
committed
Documentation is updated
1 parent 07ef0dd commit 9ad0cc8

File tree

2 files changed

+57
-57
lines changed

2 files changed

+57
-57
lines changed

README.md

Lines changed: 56 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<img alt="React Native Typescript Boilerplate" src="https://github.com/WrathChaos/react-native-typescript-boilerplate/blob/master/assets/logo.png" width="1050"/>
1+
<img alt="React Native Typescript Boilerplate" src="assets/logo.png" width="1050"/>
22

33
[![A lot of fundamental features with Typescript support React Native Boilerplate](https://img.shields.io/badge/-A%20lot%20of%20fundamental%20features%20with%20Typescript%20support%20React%20Native%20Boilerplate-orange?style=for-the-badge)](https://github.com/WrathChaos/react-native-typescript-boilerplate)
44

@@ -21,23 +21,6 @@ You can simply clone the project and start with your barebone project
2121
git clone git@github.com:WrathChaos/react-native-typescript-boilerplate.git my-app-name
2222
```
2323

24-
## Clean-Up & Simple Run
25-
26-
Clean up the files from the example repository and do not forget to install the dependencies
27-
28-
- `rm -rf .git README.md`
29-
- `rm -rf ./assets/RN-Typescript-Boilerplate.gif ./assets/logo.png`
30-
- `git init`
31-
- `npm i`
32-
- `npx pod-install` (iOS Only)
33-
- `react-native run-ios/android`
34-
35-
**OR**
36-
37-
- `npm run clean-up`
38-
- `npm i && npx pod-install`
39-
- `react-native run-ios/android`
40-
4124
# What's Included?
4225

4326
- **Navigation System**
@@ -62,43 +45,6 @@ Clean up the files from the example repository and do not forget to install the
6245
- **Built-in Custom Font Implementation**
6346
- All you need to do is copy-paste the .tff file and run `npx react-native-asset` command
6447

65-
# Step By Step Guide
66-
67-
## Rename the project: (Thanks to [react-native-name](https://github.com/junedomingo/react-native-rename))
68-
69-
```sh
70-
npx react-native-rename <your-project-name>
71-
```
72-
73-
> With custom Bundle Identifier (Android only. For iOS, please use Xcode)
74-
75-
```sj
76-
npx react-native-rename <your-project-name> -b <bundleIdentifier>
77-
```
78-
79-
### Install Pods (iOS Only)
80-
81-
- `npm i`
82-
- `cd ios && pod install`
83-
- `cd .. && react-native run-ios/android`
84-
85-
### Android local.properties (Android Only)
86-
87-
- `npm i`
88-
- `cd android && mkdir local.properties`
89-
- `nano local.properties`
90-
91-
#### Example of MacOS Android SDK Path
92-
93-
Make sure that set your right path of Android SDK
94-
95-
```
96-
ndk.dir=/Users/your-name/Library/Android/sdk/ndk-bundle
97-
sdk.dir=/Users/your-name/Library/Android/sdk
98-
```
99-
100-
- `cd .. & react-native run-ios/android`
101-
10248
# Components
10349

10450
## Styles
@@ -107,7 +53,7 @@ sdk.dir=/Users/your-name/Library/Android/sdk
10753
- Colors
10854
- Fonts
10955
- Theme
110-
- Tont-size
56+
- Font Size
11157

11258
## Imports
11359

@@ -152,6 +98,60 @@ if you want to call them all at once
15298
import { theme, fonts, colors, spacing, fontSize } from "@shared-styles/index";
15399
```
154100

101+
# Step By Step Guide
102+
103+
## Clean-Up & Simple Run
104+
105+
Clean up the files from the example repository and do not forget to install the dependencies
106+
107+
- `rm -rf .git README.md`
108+
- `rm -rf ./assets/RN-Typescript-Boilerplate.gif ./assets/logo.png`
109+
- `git init`
110+
- `npm i`
111+
- `npx pod-install` (iOS Only)
112+
- `react-native run-ios/android`
113+
114+
**OR**
115+
116+
- `npm run clean-up`
117+
- `npm i && npx pod-install`
118+
- `react-native run-ios/android`
119+
120+
## Rename the project: (Thanks to [react-native-name](https://github.com/junedomingo/react-native-rename))
121+
122+
```sh
123+
npx react-native-rename <your-project-name>
124+
```
125+
126+
> With custom Bundle Identifier (Android only. For iOS, please use Xcode)
127+
128+
```sj
129+
npx react-native-rename <your-project-name> -b <bundleIdentifier>
130+
```
131+
132+
### Install Pods (iOS Only)
133+
134+
- `npm i`
135+
- `cd ios && pod install`
136+
- `cd .. && react-native run-ios/android`
137+
138+
### Android local.properties (Android Only)
139+
140+
- `npm i`
141+
- `cd android && mkdir local.properties`
142+
- `nano local.properties`
143+
144+
#### Example of MacOS Android SDK Path
145+
146+
Make sure that set your right path of Android SDK
147+
148+
```
149+
ndk.dir=/Users/your-name/Library/Android/sdk/ndk-bundle
150+
sdk.dir=/Users/your-name/Library/Android/sdk
151+
```
152+
153+
- `cd .. & react-native run-ios/android`
154+
155155
### Future Plans
156156

157157
- [x] ~~LICENSE~~

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-native-typescript-boilerplate",
3-
"version": "1.0.5",
3+
"version": "1.0.6",
44
"description": "A lot of fundamental features with Typescript support React Native Boilerplate",
55
"scripts": {
66
"android": "react-native run-android",

0 commit comments

Comments
 (0)