Skip to content

Commit 92133e7

Browse files
author
Ahmed Elshaabany
committed
* Update README.md
1 parent 0f88838 commit 92133e7

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
1-
# Reactnative TS-TDD-Template
1+
# react-native typescript TDD template
2+
This template is a react-native boilerplate project template to start with for new projects.
3+
4+
## Features
5+
* Typescript ready: This template based on the typescript template [here](https://github.com/react-native-community/react-native-template-typescript
6+
)
7+
* React Navigation ready: Includes [react navigation](https://reactnavigation.org/) with basic working functionality out-of-the-box to work with.
8+
* TDD ready: Includes setup for [Jest](https://jestjs.io/), [Enzyme](https://enzymejs.github.io/enzyme/), [Detox](https://github.com/wix/Detox) for component and e2e testing.
9+
* Lint ready: ESlint.
210

311
### Installation
4-
>
12+
In the desired folder where you want to create the project, open command line and type:
13+
>`react-native init {PROJECT_NAME} --template https://github.com/zaprogrammer/react-native-template-typescript-tdd.git`
514
615

716

8-
Based on:
9-
https://github.com/react-native-community/cli/blob/master/docs/init.md#creating-custom-template
10-
https://github.com/react-native-community/react-native-template-typescript
1117

18+
Official documentation for creating custom project templates can be found [here](https://github.com/react-native-community/cli/blob/master/docs/init.md#creating-custom-template
19+
).

0 commit comments

Comments
 (0)