Skip to content

Commit 037cb7a

Browse files
committed
Update README
1 parent 631ce3d commit 037cb7a

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
## React Native Basic Template
2+
3+
A simple basic template to start a new React Native app with ESLint and custom scripts.
4+
5+
### Requirements
6+
7+
- react-native-cli
8+
- yarn
9+
10+
### Usage
11+
12+
Create a new project passing a template:
13+
14+
```
15+
react-native init [ProjectName] --template basic
16+
```
17+
18+
Wait for download dependencies. At finish run:
19+
20+
```
21+
yarn start
22+
```
23+
24+
To inject custom scripts and remove unnecessary files.
25+
26+
### Includes
27+
28+
- [x] ESlint (extends Airnbn)
29+
30+
### Custom Scripts
31+
32+
- [x] `android:build` - Generate Release APK
33+
- [x] `android:install` - Run in Release mode
34+
- [x] `android:shake` - Show DEV menu
35+
- [x] `ios:install` - Run in Release mode
36+
- [x] `project:clean` - Clean project
37+
- [x] `lint` - Run lint
38+
- [x] `start` - Start Metro Bundler
39+
- [x] `start:clean` - Start Metro Bundler without cache
40+
- [x] `test` - Run jest
41+
- [x] `test:watch` - Run jest in watch node_modules
42+
43+
### Roadmap
44+
45+
- [ ] Add Prettier
46+
- [ ] Add Flow
47+
- [ ] Add Enzyme
48+
- [ ] Add Lint Staged
49+
- [ ] Add Husky

0 commit comments

Comments
 (0)