EXAMPLE_README.md

%APP_NAME% - React Native App

This project was set up with following React Native App Creation Recipe.

Installation

Run yarn to install required packages.

Configuration

Copy .env.sample file as .env and change values with as you need. For .env usage check react-native-config package

After any change in .env file you need to restart react

Starting the App

Bundler

You can run only react-native bundler with the command below:

yarn start

iOS

You can reference the react native offical documentation Running on Simulaor

XCode needed to be installed to run app in ios. There is an alias script to run app easily in ios simulator

yarn ios

This is alias for react-native run-ios you can pass other options as need.

Android

Android studio to be installed to run app in android. Before run the app, start a virtual device from "Android Virtual Device Manager". When you have running android virtuald device run the following command.

yarn android

This is alias for react-native run-android. You can pass other options as need.

Testing

Jest used for testing. To run tests you can use below commands.

To run all test:

yarn test

To run test with watch:

yarn test:watch

To run coverage test:

yarn coverage

Minimum 80% test coverage required

Storybook

To start storybook run the command below:

yarn storybook

Storybook book web ui will be run at http://0.0.0.0:7007

To see stories in storybook run a simulator and select a story from web ui to show in device.

Learn More

You can learn more in the React Native documentation.

To learn how to use typescript with React Native check out the Using TypeScript with React Native.