init template

Author: hmarques98

.DS_Store

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Osama Qarem
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE

@@ -0,0 +1,353 @@
+# react-native-template
+
+[![Build Status](https://travis-ci.com/osamaq/react-native-template.svg?branch=master)](https://travis-ci.com/osamaq/react-native-template)
+[![npm downloads](https://img.shields.io/npm/dt/@osamaq/react-native-template.svg)](https://www.npmjs.com/package/@osamaq/react-native-template)
+[![npm version](https://img.shields.io/npm/v/@osamaq/react-native-template?color=44BC1C)](https://www.npmjs.com/package/@osamaq/react-native-template)
+
+<p align="center" >
+  <img
+    height="480px"
+    src="docs/assets/preview.png"
+    alt="Template landing screen preview"
+  />
+</p>
+
+<br/>
+
+An opinionated template to bootstrap your next React Native app with all the time-wasting packages you need to have.
+
+## :computer: Contributions are very welcome 🤝
+
+### Let's build the best React Native template together 🚀
+
+Preconfigured with
+
+- Synced with the recommended [TypeScript template](https://reactnative.dev/docs/typescript#getting-started-with-typescript)
+- [Storybook](https://github.com/storybookjs/storybook/) The UI component explorer. Develop, document, & test React Native components
+- [React Query](https://github.com/tannerlinsley/react-query) for api calls
+- [Axios](https://github.com/tannerlinsley/react-query) for fetch api calls
+- [Redux Toolkit](https://redux-toolkit.js.org/) for global state.
+- [React Navigation](https://reactnavigation.org/) (**v5**) for navigation and deeplinking.
+- [styled-components](https://github.com/styled-components/styled-components)
+- [styled-system](https://github.com/styled-system/styled-system)
+- [react-native-bootsplash](https://github.com/zoontek/react-native-bootsplash) because splash screens are cool.
+- [react-native-svg](https://github.com/react-native-community/react-native-svg) because svg.
+- [react-native-config](https://github.com/luggit/react-native-config) to manage separate environments (dev, staging, production).
+- [Reanimated](https://software-mansion.github.io/react-native-reanimated/) for animations.
+- [react-native-keychain](https://github.com/oblador/react-native-keychain) for Keychain/Keystore access.
+- [react-native-permissions](https://github.com/zoontek/react-native-permissions) unified permissions api for iOS and Android.
+- [NetInfo](https://github.com/react-native-netinfo/react-native-netinfo) Network Info API for Android, iOS, macOS & Windows.
+- [react-native-appstate-hook](https://github.com/amrlabib/react-native-appstate-hook) handle app state in your app.
+- [react-native-file-logger](https://github.com/BeTomorrow/react-native-file-logger) to log important stuff.
+- [react-i18next](https://github.com/i18next/react-i18next) internationalization.
+- [AsyncStorage](https://github.com/react-native-community/async-storage) you're gonna install it anyway.
+- [FastImage](https://github.com/DylanVann/react-native-fast-image) its more performant
+- [Mirage JS](https://miragejs.com/) the easiest way to mock APIs.
+- [Fastlane](http://fastlane.tools/) for automation.
+- [Code Push](https://github.com/microsoft/react-native-code-push) syncronize JavaScript and Images with over-the-air updates.
+- handy npm scripts.
+- [react-native-testing-library](https://callstack.github.io/react-native-testing-library/) for unit and component tests.
+- [Sentry](https://github.com/getsentry/sentry-react-native) for debugging in production.
+- [Detox](https://github.com/wix/Detox) for e2e.
+
+## Contents
+
+- [Documentation](#documentation)
+- [Getting Started](#getting-started)
+- [Optional Steps](#optional-steps)
+- [Credits](#credits)
+
+## Documentation
+
+- [Libraries](#libraries)
+- [Directory Structure](#directory-structure)
+- [Quick Overview](#quick-overview)
+- [File Walkthrough](./docs/file-walkthrough.md)
+
+## Getting Started
+
+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](https://github.com/react-native-community/cli#about).
+
+### RN 0.64.1
+
+```bash
+$ npx react-native init MyApp --template @hmarques98/react-native-template-typescript
+```
+
+## Road Map
+
+- Finish Detox integration
+- Add Docusaurs docs
+- [Codepush Code Signing](https://github.com/microsoft/code-push/tree/v3.0.1/cli#code-signing)
+
+## Optional Steps
+
+#### Connect To Sentry
+
+This template comes with [Sentry](https://github.com/getsentry/sentry-react-native), but its disabled until you connect your account.
+
+To connect your account:
+
+```bash
+$ cd MyApp/
+
+# For MacOS
+$ npx sentry-wizard -i reactNative -p ios android
+
+# Other Platforms
+$ npx sentry-wizard -i reactNative -p android
+```
+
+Insert your sentry DSN in each [.env](https://github.com/osamaq/react-native-template/blob/ed37c213eacf0681c4f50f959bad170d46be0ed7/template/.env.prod#L5) file (dev, staging and production) and you're all done.
+
+### Setup deep linking scheme
+
+Implementation was based on react-navigation[instructions](https://reactnavigation.org/docs/deep-linking/#set-up-with-bare-react-native-projects).
+
+1. Update the prefix with wanted URI in `App.tsx`
+
+1. iOS
+
+Update `CFBundleURLName` and `CFBundleURLSchemes` to your desired URI
+
+1. Android
+
+Update `android:scheme` value inside `<data>` tag from the `<intent-filter>`
+
+#### Enable Push Notification capability from Xcode
+
+You must be a member of the Apple Developer Program in order to enable Push Notifications
+
+![Instructions to add push notifications capability](https://i.stack.imgur.com/qsQTx.jpg)
+
+#### Customize notification appearance on Android
+
+Starting Android 10 (API 29), notification icons should be glyphs. You need to follow this step to [customize the notification appearance](https://wix.github.io/react-native-notifications/docs/installation-android/#step-6-customize-the-appearance).
+
+### Setup Code Push
+
+1. You will need to have [AppCenter CLI](https://github.com/microsoft/appcenter-cli) installed
+
+1. Creating an AppCenter account and/or organization and create an app for each platform and environment
+
+1. Copy and Replace the CodePushDeploymentKey in android/app/build.gradle under `buildTypes`
+
+1. 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`
+
+#### Add project email for the FileLogger
+
+Update project email used by `sendLoggedFiles` method in `Home.tsx`
+
+## Libraries
+
+Let's briefly go over the benefit of each library included in this template.
+
+### TypeScript
+
+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](https://github.com/react-native-community/react-native-template-typescript) so you can learn at your own pace.
+
+### styled-components
+
+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](https://styled-components.com/docs/basics#getting-started).
+
+### styled-system
+
+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](https://styled-system.com/#getting-started).
+
+### React Query
+
+Hooks for fetching, caching and updating asynchronous data in React.
+
+- Alternative: SWR/Apollo.
+
+### AXIOS
+
+## #TODO BENEFITS
+
+### Redux/Redux Toolkit
+
+I'm happy using Redux Toolkit. It's a lot more concise now and I enjoy the redux ecosystem of plugins.
+
+SWR reduces our dependency on Redux for global state. And sometimes React Navigation can be used to send data to the next screen. I try to leverage these two before reaching out to global state.
+
+If you prefer something else, remove redux and go with that. Do not waste time trying a new state management solution.
+
+### React Navigation
+
+It is the most popular navigation library. For most apps, this is the best choice.
+
+### react-native-keychain
+
+Save and use credentials from phone's Keychain/Keystore
+
+### react-native-permissions
+
+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`
+
+### react-i18next
+
+Localization using hooks. [React Native example](https://github.com/i18next/react-i18next/tree/master/example/react-native)
+
+### Codepush
+
+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!
+
+### Sentry
+
+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.
+
+In this template, there is a custom Redux [middleware](https://github.com/osamaq/react-native-template/blob/master/template/src/redux/middleware/sentryMiddleware.ts) that adds Redux actions as breadcrumbs to Sentry reports for even easier debugging.
+
+This is similar to [redux-sentry-middleware](https://github.com/vidit-sh/redux-sentry-middleware) but I've yet to test that one.
+
+### react-native-bootsplash
+
+Works great for controlling your splash screen.
+
+### react-native-svg
+
+Prefer using SVG over images all the time (remember to optimize your SVGs).
+
+### react-native-config
+
+If you have different development, staging and production variables, this library is very helpful. It allows you to declare environment variables that can be accessed by all 3 sides (android, ios, JavaScript).
+
+Android: by default, running `react-native run-android` will use the development .env file. To load .env.staging we must use:
+
+`ENVFILE=.env.staging react-native run-android`
+
+> Note: the above works on MacOS. For windows its a bit different. See [Different Environments](https://github.com/luggit/react-native-config#different-environments).
+
+iOS: two additional schemes are created in the Xcode project for staging and production. The corresponding .env file is set via the scheme's pre-action:
+
+<div align="center">
+    <img src="docs/assets/scheme.png" alt="Scheme's pre-action setting the .env file" width="100%">
+</div>
+
+NPM scripts for running the app with the desired configuration are [included](https://github.com/osamaq/react-native-template/blob/acc4f4ab117bee099a531ad44be1130f9d24df69/template/package.json#L11) for convenience.
+
+### Reanimated/Redash
+
+Necessary when creating complex gesture based animations that are highly performant. Redash contains boilerplate helpers for Reanimated.
+
+### react-native-appstate-hook
+
+Custom react hook, built to handle iOS or Android appState in your react component.
+
+### react-native-file-logger
+
+A simple file-logger for React Native with configurable rolling policy, based on CocoaLumberjack on iOS and Logback on Android.
+
+### AsyncStorage
+
+For caching simple data such as user perferences.
+
+### FastImage
+
+Drop in replacement for the `<Image/>` component. I've found this to give a performance boost on android when rendering many images.
+
+### NetInfo
+
+Network Info API for Android, iOS, macOS & Windows. It allows you to get information on:
+
+- Connection type
+- Connection quality
+
+### react-native-testing-library
+
+For unit and component testing.
+
+### Detox
+
+For end-to-end testing.
+
+### Mirage JS
+
+Mirage is an in-memory server for intercepting API calls and returning whatever data you want. Very useful for developing before the backend is deployed, and for confirming how the app reacts to different API call outcomes.
+
+### Fastlane
+
+Fastlane community has an endless amount of mobile development automation plugins. I currently use it mainly for [automatic versioning](https://osamaq.com/automatic-versioning-for-react-native-apps/), and often for deploying to Microsoft's App Center in [one command](https://github.com/osamaq/reactnative-fastlane-appcenter).
+
+This template also has a [fastlane command](https://github.com/osamaq/react-native-template/blob/acc4f4ab117bee099a531ad44be1130f9d24df69/template/fastlane/Fastfile#L203) for adding version badges to app icons. Useful outside of production as it makes it easier for QA to tell the app version.
+
+<div align="center">
+    <img src="docs/assets/ic_launcher.png" alt="App icon with version badge" width="20%">
+</div>
+
+---
+
+> _If you appreciate those libraries and find them useful, please consider supporting them._
+
+## Directory Structure
+
+```
+root
+├── __tests__
+├── android
+├── ios
+├── storybook
+|   └── addons.js
+|   └── index.js
+|   └── rn_addons.js
+└── src
+    └── components
+    |   └── Counter.tsx
+    |   └── CustomScreen.tsx
+    |   └── CustomText.tsx
+    |   └── LanguageButton.stories.tsx
+    |   └── LanguageButton.tsx
+    |   └── StatusBar.tsx
+    |   └── stories.ts
+    └── hooks
+    |   └── useCustomBackBehaviour.tsx
+    |   └── useNetworkError.tsx
+    |   └── useNotification.tsx
+    |   └── usePrevious.tsx
+    |   └── useStartupTime.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
+    |   ├── RootNavigation.tsx
+    |   └── Router.tsx
+    └── screens
+    |   ├── CustomWebView.tsx
+    |   ├── Home.tsx
+    |   ├── index.ts
+    |   └── NetworkError.tsx
+    └── utils
+        ├── colors.ts
+        └── console.ts
+
+```
+
+## Credits
+
+This template is modified from [react-native-typescript-template](https://github.com/react-native-community/react-native-template-typescript) and inspired from Osama Qarem's [React Native template](https://github.com/osamaqarem/react-native-template) and also inspired from Gabriel Moncea [React Native template](https://github.com/gabrielmoncea/react-native-template)
+
+Thank you ❤️