@reuvenorg/react-native-boilerplate-ultimate/templates/react-native-template-v1.0.0/README.md

A powerful CLI tool for creating React Native projects with modular architecture. Generate, manage, and scaffold React Native applications with pre-built modules and best practices.

A new [**React Native**](https://reactnative.dev) project, bootstrapped using [`@react-native-community/cli`](https://github.com/react-native-community/cli).

[![expo](https://img.shields.io/badge/expo-54.0.0-blue)](https://expo.dev/)
[![react](https://img.shields.io/badge/react-19.1.0-blue)](https://reactjs.org/)
[![react-native](https://img.shields.io/badge/react--native-0.81.5-blue)](https://reactnative.dev/)

# React Native Template Expo Modules

This project includes Expo modules support to leverage the best of both worlds. This hybrid approach allows us to:

- Use Expo's pre-built native modules without ejecting
- Maintain full control over native code when needed
- Access Expo's development tools and services
- Easily integrate new Expo modules as they become available

This template implements the following libraries with examples and configurations:

Navigation:

[![@react-navigation/native](https://img.shields.io/badge/@react--navigation/native-^7.1.20-blue)](https://reactnavigation.org/docs/getting-started/)
[![@react-navigation/native-stack](https://img.shields.io/badge/@react--navigation/native--stack-^7.6.3-blue)](https://reactnavigation.org/docs/stack-navigator/)
[![@react-navigation/bottom-tabs](https://img.shields.io/badge/@react--navigation/bottom--tabs-^7.8.5-blue)](https://reactnavigation.org/docs/bottom-tab-navigator/)

Animation and UI:

[![react-native-safe-area-context](https://img.shields.io/badge/react--native--safe--area--context-~5.6.0-blue)](https://github.com/th3rdwave/react-native-safe-area-context)
[![react-native-paper](https://img.shields.io/badge/react--native--paper-~5.14.5-blue)](https://callstack.github.io/react-native-paper/)
[![react-native-reanimated](https://img.shields.io/badge/react--native--reanimated-~4.1.0-blue)](https://docs.swmansion.com/react-native-reanimated/)
[![@shopify/react-native-skia](https://img.shields.io/badge/@shopify/react--native--skia-2.2.12-blue)](https://shopify.github.io/react-native-skia/)

Capabilities:

[![react-native-sensors](https://img.shields.io/badge/react--native--sensors-~7.3.6-blue)](https://github.com/react-native-sensors/react-native-sensors)
[![react-native-gesture-handler](https://img.shields.io/badge/react--native--gesture--handler-~2.28.0-blue)](https://docs.swmansion.com/react-native-gesture-handler/)

State Management:

[![@reduxjs/toolkit](https://img.shields.io/badge/@reduxjs/toolkit-^2.10.1-blue)](https://redux-toolkit.js.org/)
[![react-redux](https://img.shields.io/badge/react--redux-^9.1.2-blue)](https://react-redux.js.org/)
[![redux-logger](https://img.shields.io/badge/redux--logger-^3.0.6-blue)](https://github.com/LogRocket/redux-logger)
[![redux-persist](https://img.shields.io/badge/redux--persist-^6.0.0-blue)](https://github.com/rt2zz/redux-persist)
[![@react-native-async-storage/async-storage](https://img.shields.io/badge/@react--native--async--storage/async--storage-^2.2.0-blue)](https://react-native-async-storage.github.io/async-storage/)

Performance:

[![@shopify/flash-list](https://img.shields.io/badge/@shopify/flash--list-^2.0.2-blue)](https://shopify.github.io/flash-list/)
[![react-native-fast-image](https://img.shields.io/badge/react--native--fast--image-^8.6.3-blue)](https://github.com/DylanVann/react-native-fast-image)

## Getting Started

> **Note**: Make sure you have completed the [React Native - Environment Setup](https://reactnative.dev/docs/environment-setup) instructions till "Creating a new application" step, before proceeding.

Install dependencies:

```bash
npm install --legacy-peer-deps
```

### For Android

```bash
npm run android
```

### For iOS

First, install the pods:

```bash
npm run ios:pod-install
```

Then, run the iOS app:

```bash
npm run ios
```

## Optional Feature Modules

This template includes three optional feature modules that can be enabled or disabled independently:

### 🤖 Chat AI Module

**AI with ExecuTorch** - **works best on real high-tier devices**

[![react-native-executorch](https://img.shields.io/badge/react--native--executorch-^0.5.15-blue)](https://github.com/pytorch/executorch)

AI chat functionality with ExecuTorch integration for on-device inference.

### 🔄 Redux Module

State management examples with Redux Toolkit, including counter examples and middleware demonstrations.

### 🎨 Skia Accelerometer Module

Interactive graphics using React Native Skia combined with device accelerometer sensors for motion-based animations.

### Module Management

```bash
# Interactive module setup
npm run modules:setup

# Check status of all modules
npm run modules:status

# Enable specific modules
npm run modules:enable md-chat-ai-screen

# Disable specific modules
npm run modules:disable md-chat-ai-screen
```

Each module is implemented as a separate React Native library that can be linked/unlinked independently. When disabled, modules show placeholder screens with re-enabling instructions. This modular approach helps reduce bundle size and dependencies when features aren't needed.

## App Icons and Splash Screens

This template includes custom scripts to generate app icons and splash screens for both iOS and Android:

### Generate icons and splash screens for bare React Native with Expo modules

```bash
npm run icons:generate
```

This script generates:

- App icons for Android in various densities (mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi)
- Round icons for Android
- App icons for iOS in all required dimensions
- Splash screen images for Android
- Splash screen background color for iOS
- Standard Expo assets in the assets/ directory for compatibility

### Generate iOS splash screen logo

```bash
npm run icons:splash-logo
```

This script generates:

- iOS splash screen logo image in 1x, 2x, and 3x resolutions
- Updates the necessary Contents.json file

### Additional Commands

```bash
# Check Expo installation
npm run expo:doctor

# Check for package updates
npm run expo:check

# Clean and refresh the project
npm run refresh

# Clean iOS build
npm run ios:clean

# Clean Android build
npm run android:clean

# Get iOS devices
npm run ios:devices

# Get Android devices
npm run android:devices
```

## License

MIT