The definitive React-Native Starter app kit

React Native Starter App

A React Native template to bootstrap your next app!

Table of Contents

• Installation :inbox_tray:
• Environment Setup :globe_with_meridians:
• Contributors :sparkles:

Installation :inbox_tray:

> git clone https://github.com/IronTony/react-native-starter-app

> cd react-native-starter-app

# Install dependencies
> yarn

# if needed, setup iOS development environment
yarn setup:ios

See environment section for how to configure env variables.

See scripts section for how to run the app.

Environment Setup :globe_with_meridians:

React Native Starter App environments variables management is based on a custom script and the app.json config file.

Define your environment variables inside app.json inside the environments object under the desired environment key (such as development , staging or production ) and then run the app for the required env using one of the available run scripts (e.g. ios:dev ).

Scripts :wrench:

Run the app

To run the app use one of the following scripts:

• yarn android:dev , to start the app on Android with the development environment variables.

• yarn android:stage , to start the app on Android with the staging environment variables.

• yarn android:prod , to start the app on Android with the production environment variables.

• yarn ios:dev , to start the app on iOS with the development environment variables.

• yarn ios:stage , to start the app on iOS with the staging environment variables.

• yarn ios:prod , to start the app on iOS with the production environment variables.

Generate app icons

To setup the app icons:

• create an image at least 1024x1024px
• place it under /assets folder as icon.png
• run

yarn assets:icons

Generate Splashscreen

To setup the app splashscreen:

• create an image at least 1242x2208px
• place it under /assets folder as splashscreen.png
• run

yarn assets:splashscreen

Setup iOS

To setup the environment to run on iOS, run

yarn setup:ios

this will run cocoapods to install all the required dependencies.

Roadmap :runner:

:white_check_mark: Remove UIKitten

:white_check_mark: Add UI Design System ( NativeBase )

:white_check_mark: Add Env variables selection experimental way ⚗️ ⚗️ ⚗️

Contributors :sparkles:

Thanks goes to these wonderful people ( emoji key ):

IronTony

Mattia Panzeri

This project follows the all-contributors specification. Contributions of any kind welcome!

License :scroll:

Licensed under Mozilla Public License Version 2.0