Skip to content
This repository has been archived by the owner on Jun 8, 2022. It is now read-only.

Latest commit

 

History

History
73 lines (46 loc) · 6.78 KB

README.md

File metadata and controls

73 lines (46 loc) · 6.78 KB

prime-logo

⚠️This repository has been moved to the Prime Monorepo.

React Native Prime

This boilerplate is based on the core principles of React Prime.

Install all dependencies as described in the React Native docs (Don't forget to select the "React Native CLI Quickstart" tab instead of "Expo CLI Quickstart"). Also install Xcode and Android Studio as suggested in the docs.

📖 Installation

To install the project we recommend to use our NPX command create-react-prime. To create a React Native project you can run npx create-react-prime PROJECT --type native.

🚨🚨🚨 Chose a lowercase name without any special characters e.g: jobner, figo, rocycle.

Before you start, install the project dependencies (1/2; Make sure Cocoapods is installed as well). Next run the React Native metro bundler in a terminal tab (3). In a seperate terminal tab you have to run the project for the platform of choice (4):

  1. npm install
  2. cd ios && pod install
  3. npm run start start -- --reset-cache
  4. npm run ios or npm run android
  5. Add your app to App Store Connect and to Fabric.io (both with code signing)

This will start the project with the correct simulator. You can also run you project on physical devices. Connect your device via usb. For iOS you will have to open ios/PROJECT.xcworkspace in Xcode and select your device in the top left corner. For Android you have to look into using adb. List your connected device by running adb devices. With a device connected npm run android will automatically open the project on your device.

Latest tested, working Android Studio Gradle version is v3.6.3.

TypeScript

This repository support TypeScript. Create your project using npx create-react-prime PROJECT --type native --typescript.

️⚒️ Environments

The different environments are managed via productFlavors for Android and schemes for iOS. The Android productFlavors can be found in android/app/build.gradle. For iOS you can find the schemes by opening the ios/PROJECT.xcworkspace file. The schemes will be shown in the top left corner.

🎨 App icons

Manually

The app icons can be changed. For Android you can find the icons in android/app/src/main/res/mipmap-*. You can just replace the icons. For iOS you can replace the files in ios/PROJECT/Images.xcassets. Although you can edit the images via Xcode as well.

Automatic asset generation

The app icons can be generated. For this you can find an assets folder in the root of the project, where you place the required app icon that will be used for the new splash screen. Please follow the documentation of Bootsplash to make a new splash screen with generated assets. Note that you need to delete the previous .storyboard file and pull the new one into Xcode in order to take effect.

🚀 Releasing

I recommend using a version branch as used in Gitflow. For example create a branch called release/1.0.1. Run the application in both production and development environments and fix the latest bugs. Also do not forget to bump your version- and build numbers. For iOS open ios/PROJECT.xcworkspace and bump the numbers in the Info tab. For Android open android/app/build.gradle and look for versionCode and versionName.

⚡️ Animations

React Native runs, separately from Native code, on a JS thread instead of the UI thread. Between these threads there is a "Bridge" to communicate. This communication is mostly expensive and slow. To run animations on 60FPS you can use declarative animations on the UI thread using the third-party libraries react-native-gesture-handler and react-native-reanimated. This talk Declarative future of gestures and animations in React Native explains more about declarative animations.

📱 Testing

If you want to extend your application with tests I recommend to look into react-native-testing-library for unit testing or detox for end-to-end testing.

🔍 Debugging

For debugging React Native application you should use Flipper. It's a native debug tool developed by Facebook, supporting all kinds of debugging from Network Requests to Logs and Crash Reports. There are many plugins available as well e.g. React Navigation Devtools or React Query Devtools.

To install Flipper run (or read installation instructions): brew install --cask flipper

💚 Third-party libraries

react-native-config

To manage different variables for the different environments we use react-native-config. It loads an .env.* file via productFlavors on Android and schemes on iOS. This is all setup and works out of the box. You can add secrets in your environment files. It's up to you if you add them to your .gitignore.

react-native-bootsplash

For creating a custom splashscreen we use react-native-bootsplash. This packages is created to design your launch screen using the platform depended tools Xcode layout editor and Android drawable resource. You can find how to create splash screens over there.

@react-native-async-storage/async-storage

To handle your locale storage you have to use @react-native-async-storage/async-storage. This package let you handle local data based on a Promise API. Note that you can only store strings inside local data, just as on web.

react-native-device-info

If you want detect certain devices it's recommended to use react-native-device-info. This package offers a great Promise based API which let's you get all different kinds of data from the devices. Note the differences between Android and iOS.