Emin Khateeb
9eba4e6e48
* completed eslint ts setup and fixed eslint issues
* minor change in direction 😄
* upgraded type definitions
* declared custom global variable
* moved global var definition below imports
52 lines
2.2 KiB
Markdown
52 lines
2.2 KiB
Markdown
# :space_invader: React Native Template TypeScript
|
|
|
|
<p>
|
|
<a href="https://travis-ci.org/react-native-community/react-native-template-typescript">
|
|
<img alt="Build Status" src="https://img.shields.io/travis/react-native-community/react-native-template-typescript.svg" target="_blank" />
|
|
</a>
|
|
<a href="https://github.com/react-native-community/react-native-template-typescript#readme">
|
|
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" target="_blank" />
|
|
</a>
|
|
<a href="https://github.com/react-native-community/react-native-template-typescript/graphs/commit-activity">
|
|
<img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" target="_blank" />
|
|
</a>
|
|
<a href="https://github.com/react-native-community/react-native-template-typescript/blob/master/LICENSE">
|
|
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" target="_blank" />
|
|
</a>
|
|
</p>
|
|
|
|
> Clean and minimalist React Native template for a quick start with TypeScript.
|
|
|
|
## :star: Features
|
|
|
|
- Elegant usage directly within the [React Native CLI](https://github.com/react-native-community/cli)
|
|
- Consistent with the default React Native template
|
|
- Minimal additional dependencies
|
|
|
|
## :arrow_forward: Usage
|
|
|
|
### Note on the legacy CLI
|
|
There seems to be quite some confusion about the legacy CLI. This template only works with the new CLI. Make sure you have uninstalled the legacy `react-native-cli` first (`npm uninstall -g react-native-cli`), for the below command to work. If you wish to not use `npx`, you can also install the new CLI globally (`npm i -g @react-native-community/cli` or `yarn global add @react-native-community/cli`).
|
|
|
|
Further information can be found here: https://github.com/react-native-community/cli#about
|
|
|
|
### `react-native@0.61.0` or higher
|
|
|
|
```sh
|
|
npx react-native init MyApp --template react-native-template-typescript
|
|
```
|
|
|
|
### `react-native@0.60.x`
|
|
|
|
```sh
|
|
npx react-native init MyApp --template react-native-template-typescript@6.2.0
|
|
```
|
|
|
|
## :computer: Contributing
|
|
|
|
Contributions are very welcome. Please check out the [contributing document](CONTRIBUTING.md).
|
|
|
|
## :bookmark: License
|
|
|
|
This project is [MIT](LICENSE) licensed.
|