An opinionated template to bootstrap your next React Native app with all the time-wasting packages you need to have.
Please check out the contributing document.
Preconfigured with
- Synced with the recommended TypeScript template
- Storybook The UI component explorer. Develop, document, & test React Native components
- React Query for api calls
- Zustand instead of Redux
- styled-components
- styled-system
- React Navigation for navigation and deeplinking.
- Wix React Native Notifications native notifications.
- react-native-keychain for Keychain/Keystore access.
- react-native-permissions unified permissions api for iOS and Android.
- react-i18next internationalization.
- Code Push syncronize JavaScript and Images with over-the-air updates.
- Crisp chat free live customer support.
- Sentry for debugging in production.
- react-native-appstate-hook handle app state in your app.
- react-native-file-logger to log important stuff.
- react-native-svg because svg.
- react-native-dotenv
- AsyncStorage you're gonna install it anyway.
- NetInfo Network Info API for Android, iOS, macOS & Windows.
- FastImage its more performant.
- react-native-testing-library for unit and component tests.
- Detox for e2e.
- why-did-you-render to avoid re-renders.
Create a new project using the template.
- Note: the command will fail if you have the global legacy react-native-cli installed. Make sure you uninstall it first. More info at react-native-community/cli.
npx react-native init MyApp --template @gabimoncha/react-native-template| React Native | Template |
|---|---|
| 0.64 | 1.1.2 |
- Finish Detox integration
- Add Docusaurs docs
- Codepush Code Signing
Implementation was based on react-navigationinstructions.
-
Update the prefix with wanted URI in
App.tsx -
iOS
Update CFBundleURLName and CFBundleURLSchemes to your desired URI
- Android
Update android:scheme value inside <data> tag from the <intent-filter>
-
Android Create a Firebase project, change bundle id, register your app in Firebase, replace configuration file android/app/google-services.json
-
iOS Enable Push Notification capability from Xcode You must be a member of the Apple Developer Program in order to enable Push Notifications
Starting Android 10 (API 29), notification icons should be glyphs. You need to follow this step to customize the notification appearance.
-
You will need to have AppCenter CLI installed
-
Creating an AppCenter account and/or organization and create an app for each platform and environment
-
Copy and Replace the CodePushDeploymentKey in android/app/build.gradle under
buildTypes -
Copy and Replace the CodePushDeploymentKey in android/app/build.gradle and XCode -> YourProject -> Build Settings ->
CODE_PUSH_KEY
You can retrieve this values by running appcenter codepush deployment list -a <ownerName>/<appName> -k
Register an account and website on the platform. Go to Settings > Website settings > Select website > Set up Instructions > Copy Website ID and replace it in AppDelegate.m and MainApplication.java
This template comes with Sentry, but its disabled until you connect your account.
To connect your account:
$ cd MyApp/
# For MacOS
$ npx sentry-wizard -i reactNative -p ios android
# Other Platforms
$ npx sentry-wizard -i reactNative -p androidInsert your sentry DSN in each .env file (dev, staging and production) and you're all done.
Update project email used by sendLoggedFiles method in Home.tsx
Let's briefly go over the benefit of each library included in this template.
For type safety ¯\(ツ)/¯
But in all seriousness, if you are considering this template I assume you are a TypeScript fan. If you happen to be a JavaScript user, this template might be overwhelming. If you would like to start learning TypeScript, I suggest bootstrapping with this instead react-native-community/react-native-template-typescript so you can learn at your own pace.
Storybook is a development environment for UI components. It allows you to browse a component library, view the different states of each component, and interactively develop and test components
Hooks for fetching, caching and updating asynchronous data in React.
A small, fast and scaleable bearbones state-management solution. Has a comfy api based on hooks, isn't boilerplatey or opinionated, but still just enough to be explicit and flux-like.
Style your apps without stress with dynamic styling and painless maintenance. styled-components utilises tagged template literals to style your component. Checkout this Getting started tutorial.
Styled System is a collection of utility functions that add style props to your React components and allows you to control styles based on a global theme object with typographic scales, colors, and layout properties. Checkout this Getting started tutorial.
Routing and navigation for your React Native apps Platform-specific look-and-feel with smooth animations and gestures.
Handle all the aspects of push notifications for your app, including remote and local notifications, interactive notifications, silent notifications, and more.
Save and use credentials from phone's Keychain/Keystore
A unified permissions API for React Native on iOS and Android. For iOS you have to the Podfile with permissions pod and update Info.plist with wanted permissions descriptions. For Android add wanted permissions in AndroidManifest.xml
Localization using hooks. React Native example
A React Native app is composed of JavaScript files and any accompanying images, which are bundled together by the packager and distributed as part of a platform-specific binary (i.e. an .ipa or .apk file). Once the app is released, updating either the JavaScript code (e.g. making bug fixes, adding new features) or image assets, requires you to recompile and redistribute the entire binary, which of course, includes any review time associated with the store(s) you are publishing to.
The CodePush plugin helps get product improvements in front of your end users instantly, by keeping your JavaScript and images synchronized with updates you release to the CodePush server. This way, your app gets the benefits of an offline mobile experience, as well as the "web-like" agility of side-loading updates as soon as they are available. It's a win-win!
A free alternative to Intercom or Zendesk, for startups and SMBs. Crisp chat
Benefitial in debugging issues that occur only in release builds. You can view error stack traces for unhandled exceptions. You can also choose to log specific errors in some catch blocks to study how often they occur in production.
Custom react hook, built to handle iOS or Android appState in your react component.
A simple file-logger for React Native with configurable rolling policy, based on CocoaLumberjack on iOS and Logback on Android.
Prefer using SVG over images all the time (remember to optimize your SVGs).
Using environment variables in your React Native project
For caching simple data such as user preferences.
Network Info API for Android, iOS, macOS & Windows. It allows you to get information on:
- Connection type
- Connection quality
Replacement for the <Image/> component. Gives a performance boost and imaga preload.
For unit and component testing.
For end-to-end testing.
Fix avoidable re-renders
root
├── __tests__
├── android
├── ios
├── storybook
| └── addons.js
| └── index.js
| └── rn_addons.js
└── src
└── components
| └── LanguageButton
| | └── index.tsx
| | └── LanguageButton.tsx
| | └── stories.tsx
| └── Counter.tsx
| └── CustomScreen.tsx
| └── CustomText.tsx
| └── StatusBar.tsx
| └── stories.ts
└── hooks
| └── useCustomBackBehaviour.tsx
| └── useMockApi.tsx
| └── useNotification.tsx
| └── usePrevious.tsx
└── localization
| └── resources
| | └── en.json
| | └── index.ts
| | └── ro.json
| └── index.tsx
└── modules
| └── auth
| | └── hooks
| | | └── useKeychainBiometrics.tsx
| | | └── useKeychainCredentials.tsx
| | | └── useSupportedBiometry.tsx
| | └── screens
| | | └── index.tsx
| | | └── Onboarding.tsx
| | | └── ResetPassword.tsx
| | └── store
| | | └── index.ts
| └── <your_app_modules>
└── navigation
| ├── navigatorMethods.tsx
| └── Router.tsx
└── screens
| ├── CustomWebView.tsx
| ├── Home.tsx
| ├── index.ts
| └── NetworkError.tsx
└── utils
├── colors.ts
└── console.ts
This template is modified from react-native-typescript-template and inspired from Osama Qarem's React Native temaplate
Thank you ❤️