> For the complete documentation index, see [llms.txt](https://abdulhamidoumer.gitbook.io/rn-ts-boilerplate/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://abdulhamidoumer.gitbook.io/rn-ts-boilerplate/getting-started.md).

# Getting Started

Getting started with the template is fairly easy. There are only a few number of steps as listed down below.

{% hint style="warning" %}
using [YARN](https://yarnpkg.com/) over NPM is recommened when using this template.
{% endhint %}

1\. Create react native app by providing`react-native-typescript-boilerplate` as a template.

```
npx react-native myapp --template https://github.com/abdulhamidOumer/react-native-typescript-boilerplate.git
```

2\. Get into the generated app's directory and explore the code and features.

```
cd myapp
yarn start
```

3\. Get started by setting your app icon or splash screen icon.

```
yarn set
```

4\. Optional - Initiate husky pre-commit hooks.

```
yarn init-husky
```